mirror of
https://github.com/zhigang1992/react-native.git
synced 2026-01-12 22:50:10 +08:00
fe80a0c01d
Summary: See https://help.github.com/en/articles/adding-support-resources-to-your-project. The SUPPORT file is surfaced by GitHub in several useful places. The goal is to increase discoverability of all support resources, giving the reader an opportunity to find the help they need before they open an issue in the repository. A secondary goal is to use a friendlier tone when communicating our processes. The issue templates have been standardized to follow the format used by GitHub's template tool. A bug in the "Regressions" template, due to its use of multiple labels, is fixed as well. The bot will explain how a changelog can be fixed when it nags a PR. [General][Added] - Added SUPPORT resources, friendlier messaging. Pull Request resolved: https://github.com/facebook/react-native/pull/23778 Differential Revision: D14333911 Pulled By: hramos fbshipit-source-id: d4b3e75194ea7d5c932dd8df2393d5b189f30f35
96 lines
4.7 KiB
JavaScript
96 lines
4.7 KiB
JavaScript
/**
|
|
* Copyright (c) Facebook, Inc. and its affiliates.
|
|
*
|
|
* This source code is licensed under the MIT license found in the
|
|
* LICENSE file in the root directory of this source tree.
|
|
*
|
|
* To test Danger during development, run yarn in this directory, then run:
|
|
* $ yarn danger pr <URL to GitHub PR>
|
|
*
|
|
* @format
|
|
*/
|
|
|
|
'use strict';
|
|
|
|
const includes = require('lodash.includes');
|
|
|
|
const {danger, fail, message, warn} = require('danger');
|
|
|
|
// Provides advice if a summary section is missing, or body is too short
|
|
const includesSummary =
|
|
danger.github.pr.body &&
|
|
danger.github.pr.body.toLowerCase().includes('## summary');
|
|
if (!danger.github.pr.body || danger.github.pr.body.length < 50) {
|
|
fail(':grey_question: This pull request needs a description.');
|
|
} else if (!includesSummary) {
|
|
const title = ':clipboard: Missing Summary';
|
|
const idea =
|
|
'Can you add a Summary? ' +
|
|
'To do so, add a "## Summary" section to your PR description. ' +
|
|
'This is a good place to explain the motivation for making this change.';
|
|
message(`${title} - <i>${idea}</i>`);
|
|
}
|
|
|
|
// Warns if there are changes to package.json, and tags the team.
|
|
const packageChanged = includes(danger.git.modified_files, 'package.json');
|
|
if (packageChanged) {
|
|
const title = ':lock: package.json';
|
|
const idea =
|
|
'Changes were made to package.json. ' +
|
|
'This will require a manual import by a Facebook employee.';
|
|
warn(`${title} - <i>${idea}</i>`);
|
|
}
|
|
|
|
// Provides advice if a test plan is missing.
|
|
const includesTestPlan =
|
|
danger.github.pr.body &&
|
|
danger.github.pr.body.toLowerCase().includes('## test plan');
|
|
if (!includesTestPlan) {
|
|
const title = ':clipboard: Missing Test Plan';
|
|
const idea =
|
|
'Can you add a Test Plan? ' +
|
|
'To do so, add a "## Test Plan" section to your PR description. ' +
|
|
'A Test Plan lets us know how these changes were tested.';
|
|
message(`${title} - <i>${idea}</i>`);
|
|
}
|
|
|
|
// Regex looks for given categories, types, a file/framework/component, and a message - broken into 4 capture groups
|
|
const changelogRegex = /\[\s?(ANDROID|GENERAL|IOS)\s?\]\s*?\[\s?(ADDED|CHANGED|DEPRECATED|REMOVED|FIXED|SECURITY)\s?\]\s*?\-?\s*?(.*)/gi;
|
|
const includesChangelog =
|
|
danger.github.pr.body &&
|
|
(danger.github.pr.body.toLowerCase().includes('## changelog') ||
|
|
danger.github.pr.body.toLowerCase().includes('release notes'));
|
|
const correctlyFormattedChangelog = changelogRegex.test(danger.github.pr.body);
|
|
|
|
// Provides advice if a changelog is missing
|
|
const changelogInstructions =
|
|
'A changelog entry has the following format: `[CATEGORY] [TYPE] - Message`.\n\n<details>CATEGORY may be:\n\n- General\n- iOS\n- Android\n\nTYPE may be:\n\n- Added, for new features.\n- Changed, for changes in existing functionality.\n- Deprecated, for soon-to-be removed features.\n- Removed, for now removed features.\n- Fixed, for any bug fixes.\n- Security, in case of vulnerabilities.\n\nMESSAGE may answer "what and why" on a feature level. Use this to briefly tell React Native users about notable changes.</details>';
|
|
if (!includesChangelog) {
|
|
const title = ':clipboard: Missing Changelog';
|
|
const idea =
|
|
'Can you add a Changelog? ' +
|
|
'To do so, add a "## Changelog" section to your PR description. ' +
|
|
changelogInstructions;
|
|
message(`${title} - <i>${idea}</i>`);
|
|
} else if (!correctlyFormattedChangelog) {
|
|
const title = ':clipboard: Changelog Format';
|
|
const idea = 'Did you include a Changelog? ' + changelogInstructions;
|
|
message(`${title} - <i>${idea}</i>`);
|
|
}
|
|
|
|
// Warns if the PR is opened against stable, as commits need to be cherry picked and tagged by a release maintainer.
|
|
// Fails if the PR is opened against anything other than `master` or `-stable`.
|
|
const isMergeRefMaster = danger.github.pr.base.ref === 'master';
|
|
const isMergeRefStable = danger.github.pr.base.ref.indexOf('-stable') !== -1;
|
|
if (!isMergeRefMaster && isMergeRefStable) {
|
|
const title = ':grey_question: Base Branch';
|
|
const idea =
|
|
'The base branch for this PR is something other than `master`. Are you sure you want to merge these changes into a stable release? If you are interested in backporting updates to an older release, the suggested approach is to land those changes on `master` first and then cherry-pick the commits into the branch for that release. The [Releases Guide](https://github.com/facebook/react-native/blob/master/Releases.md) has more information.';
|
|
warn(`${title} - <i>${idea}</i>`);
|
|
} else if (!isMergeRefMaster && !isMergeRefStable) {
|
|
const title = ':exclamation: Base Branch';
|
|
const idea =
|
|
'The base branch for this PR is something other than `master`. [Are you sure you want to target something other than the `master` branch?](http://facebook.github.io/react-native/docs/contributing.html#pull-requests)';
|
|
fail(`${title} - <i>${idea}</i>`);
|
|
}
|