From 7fac3ee5474fa5a79eb57a13dd5738c4616d1f02 Mon Sep 17 00:00:00 2001 From: Pete Gonzalez <4673363+octogonz@users.noreply.github.com> Date: Mon, 25 Mar 2019 19:59:45 -0700 Subject: [PATCH] Update content to reflect changes in Rush 5.6.3 --- pages/configs/environment_vars.md | 6 ++++++ pages/configs/rush_json.md | 31 +++++++++++++++++++++++++------ 2 files changed, 31 insertions(+), 6 deletions(-) diff --git a/pages/configs/environment_vars.md b/pages/configs/environment_vars.md index 10fbb73e..ded91ca2 100644 --- a/pages/configs/environment_vars.md +++ b/pages/configs/environment_vars.md @@ -29,3 +29,9 @@ $ rush install This variable selects an alternate installation variant for Rush to use when installing and linking package dependencies. For more information about this feature, see [Installation Variants]({% link pages/advanced/installation_variants.md %}). + +## RUSH_ABSOLUTE_SYMLINKS + +If this variable is set to "true", Rush will create symlinks with absolute paths instead +of relative paths. This can be necessary when a repository is moved during a build or +if parts of a repository are moved into a sandbox. diff --git a/pages/configs/rush_json.md b/pages/configs/rush_json.md index 482ad3c3..33526126 100644 --- a/pages/configs/rush_json.md +++ b/pages/configs/rush_json.md @@ -25,7 +25,7 @@ This is the template that `rush init` generates for **rush.json** (in the repo r * path segment in the "$schema" field for all your Rush config files. This will ensure * correct error-underlining and tab-completion for editors such as VS Code. */ - "rushVersion": "5.4.0", + "rushVersion": "5.6.3", /** * The next field selects which package manager should be installed and determines its version. @@ -76,7 +76,7 @@ This is the template that `rush init` generates for **rush.json** (in the repo r * rush install, rush update, rush link, rush version, rush publish * * In some cases you may want this turned on, but need to allow certain packages to use a different - * version. In those cases, you will need to add an entry to the "allowedAlternateVersions" + * version. In those cases, you will need to add an entry to the "allowedAlternativeVersions" * section of the common-versions.json. */ // "ensureConsistentVersions": true, @@ -169,14 +169,33 @@ This is the template that `rush init` generates for **rush.json** (in the repo r * of a recommended email. Make sure it conforms to one of the allowedEmailRegExps * expressions. */ - // "sampleEmail": "mrexample@users.noreply.github.com" + // "sampleEmail": "mrexample@users.noreply.github.com", + + /** + * The commit message to use when committing changes during 'rush publish'. + * + * For example, if you want to prevent these commits from triggering a CI build, + * you might configure your system's trigger to look for a special string such as "[skip-ci]" + * in the commit message, and then customize Rush's message to contain that string. + */ + // "versionBumpCommitMessage": "Applying package updates. [skip-ci]" }, "repository": { /** - * This setting is sometimes needed when using "rush change" with multiple Git remotes. - * It specifies the remote url for the official Git repository. If this URL is provided, - * "rush change" will use it to find the right remote to compare against. + * The URL of this Git repository, used by "rush change" to determine the base branch for your PR. + * + * The "rush change" command needs to determine which files are affected by your PR diff. + * If you merged or cherry-picked commits from the master branch into your PR branch, those commits + * should be excluded from this diff (since they belong to some other PR). In order to do that, + * Rush needs to know where to find the base branch for your PR. This information cannot be + * determined from Git alone, since the "pull request" feature is not a Git concept. Ideally + * Rush would use a vendor-specific protocol to query the information from GitHub, Azure DevOps, etc. + * But to keep things simple, "rush change" simply assumes that your PR is against the "master" branch + * of the Git remote indicated by the respository.url setting in rush.json. If you are working in + * a GitHub "fork" of the real repo, this setting will be different from the repository URL of your + * your PR branch, and in this situation "rush change" will also automatically invoke "git fetch" + * to retrieve the latest activity for the remote master branch. */ // "url": "https://github.com/Microsoft/rush-example" },