diff --git a/README.md b/README.md index 674b0539a..abca80c46 100644 --- a/README.md +++ b/README.md @@ -12,7 +12,7 @@ --- -
CircleCI Codecov npm All Contributors npm Auto Release +
CircleCI Codecov npm All Contributors npm Auto Release code style: prettier

diff --git a/docs/pages/blog/pr-in-progress.mdx b/docs/pages/blog/pr-in-progress.mdx index 9a5a6d9c8..db49f402c 100644 --- a/docs/pages/blog/pr-in-progress.mdx +++ b/docs/pages/blog/pr-in-progress.mdx @@ -8,7 +8,7 @@ date: "Thu, 12 Mar 2020 23:00:02 -0700" Sometimes you are working on a big feature and you know it will require a lot of changes. These types of pull requests can be a nightmare to review. Taking in all the changes at once can be overwhelming. It makes it easy to miss smaller mistakes and can make it hard to guess the intent of the changes. Multiple features, bug fixes, or even breaking changes may make up this large PR. -One way to manage this problem is by making a PR to the large PR. Other contributors can review a smaller subset of changes and also follow along with development. In previous versions of `auto`, large PRs would not be represented well in the changelog and release notes. It would only include the main PR that got merged into master as the only changelog note. +One way to manage this problem is by making a PR to the large PR. Other contributors can review a smaller subset of changes and also follow along with development. In previous versions of `auto`, large PRs would not be represented well in the changelog and release notes. It would only include the main PR that got merged into `baseBranch` as the only changelog note. But thanks to [this PR](https://github.com/intuit/auto/pull/359) that isn't true anymore! Now when you merge one PR to another both changes will be represented in the changelog. diff --git a/docs/pages/blog/using-shipit.mdx b/docs/pages/blog/using-shipit.mdx index 0b7f9ca48..a6458e9cc 100644 --- a/docs/pages/blog/using-shipit.mdx +++ b/docs/pages/blog/using-shipit.mdx @@ -10,7 +10,7 @@ date: 'Thu, 12 Mar 2020 23:00:02 -0700' The main command most users use to interact with `auto` is the shipit command. shipit does all the heaving lifting when releasing your code. -When run on master it will: +When run on `baseBranch` it will: 1. Determine if the last merged PR needs to be released 2. Update a CHANGELOG.md with all you new changes diff --git a/docs/pages/blog/v8.mdx b/docs/pages/blog/v8.mdx index 032ccecd7..6130492d3 100644 --- a/docs/pages/blog/v8.mdx +++ b/docs/pages/blog/v8.mdx @@ -62,7 +62,7 @@ Run `auto next` from `feature` branch => Publish prerelease to `beta` tag. The `shipit` command will now also publish a prerelease when ran from a prerelease branch. You can use this in a few different ways: -1. Two release branches: `master` and `next` +1. Two release branches: `baseBranch` and `next` 2. Without `next` Branch (`--only-graduate-with-release-label`) 3. Multiple `next` Branches (ex: `alpha`, `beta`, `rc`) 4. Feature Pre-releases diff --git a/docs/pages/docs/build-platforms/circleci.mdx b/docs/pages/docs/build-platforms/circleci.mdx index b5b26e34d..f582e52d2 100644 --- a/docs/pages/docs/build-platforms/circleci.mdx +++ b/docs/pages/docs/build-platforms/circleci.mdx @@ -4,7 +4,7 @@ title: CircleCI The following config declares the `release` job and uses it in the `build_and_release` workflow. The `release` job will run at the end of each build and either release: -- a new `latest` version from `master` +- a new `latest` version from `baseBranch` - a `canary` build from a pull request (if your package manager plugin implements them) ```yaml @@ -51,5 +51,5 @@ Go to Settings -> Checkout SSH Keys -> `Create and add YOUR_USERNAME user key`. ## Examples -- [`auto`](https://github.com/intuit/auto/blob/master/.circleci/config.yml) +- [`auto`](https://github.com/intuit/auto/blob/main/.circleci/config.yml) - [`reaction`](https://github.com/artsy/reaction/blob/master/.circleci/config.yml) diff --git a/docs/pages/docs/build-platforms/github-actions.mdx b/docs/pages/docs/build-platforms/github-actions.mdx index 377eb1849..39d4d33f2 100644 --- a/docs/pages/docs/build-platforms/github-actions.mdx +++ b/docs/pages/docs/build-platforms/github-actions.mdx @@ -4,7 +4,7 @@ title: GitHub Actions The following config declares the `release` action that run on all branches. The job will either release: -- a new `latest` version from `master` +- a new `latest` version from `baseBranch` - a `canary` build from a pull request (only on the main fork and if your package manager plugin implements them) **`.github/workflows/release.yml`** diff --git a/docs/pages/docs/build-platforms/jenkins.mdx b/docs/pages/docs/build-platforms/jenkins.mdx index da1ff043b..6c7078e49 100644 --- a/docs/pages/docs/build-platforms/jenkins.mdx +++ b/docs/pages/docs/build-platforms/jenkins.mdx @@ -4,7 +4,7 @@ title: Jenkins 2 The following config declares the `release` action that run on all branches. The job will either release: -- a new `latest` version from `master` +- a new `latest` version from `baseBranch` - a `canary` build from a pull request (only on the main fork and if your package manager plugin implements them) **`Jenkinsfile`** @@ -74,13 +74,13 @@ pipeline { } } stage('Latest') { - when { branch 'master' } + when { branch 'main' } steps { // Jenkins will leave you in a detached HEAD state during builds // Make sure to checkout your baseBranch here or the push will fail! // The error will look like the following: - // error: src refspec master does not match any - sh 'git checkout master' + // error: src refspec main does not match any + sh 'git checkout main' sh 'auto shipit' } } diff --git a/docs/pages/docs/build-platforms/travis.mdx b/docs/pages/docs/build-platforms/travis.mdx index 7aa6f45f9..5c06813f5 100644 --- a/docs/pages/docs/build-platforms/travis.mdx +++ b/docs/pages/docs/build-platforms/travis.mdx @@ -4,7 +4,7 @@ title: Travis CI The following config declares the `deploy` job that run on all branches. The job will either release: -- a new `latest` version from `master` +- a new `latest` version from `baseBranch` - a `canary` build from a pull request (if your package manager plugin implements them) **`.travis.yml`** @@ -44,12 +44,12 @@ To fix this add the following lines to your `.travis.yml` ```yml before_deploy: - - if [ "$TRAVIS_BRANCH" == "master" ];then - git checkout master; + - if [ "$TRAVIS_BRANCH" == "main" ];then + git checkout main; fi; ``` -This code will ensure that your git HEAD is on master when creating a new release. +This code will ensure that your git HEAD is on `baseBranch` when creating a new release. ### Canary Deploy Failing on Forks diff --git a/docs/pages/docs/configuration/autorc.mdx b/docs/pages/docs/configuration/autorc.mdx index 257f65512..9d1e33626 100644 --- a/docs/pages/docs/configuration/autorc.mdx +++ b/docs/pages/docs/configuration/autorc.mdx @@ -37,7 +37,7 @@ Configure the default release behavior. ### Base Branch -Configure what your repo considers the "master" branch. +Configure what your repo considers the base branch. ```json { diff --git a/docs/pages/docs/extras/changelog.md b/docs/pages/docs/extras/changelog.md index 5e9e846cf..e774ee2c0 100644 --- a/docs/pages/docs/extras/changelog.md +++ b/docs/pages/docs/extras/changelog.md @@ -36,7 +36,7 @@ _From #371_ #### 💥 Breaking Change -- shipit will publish a canary locally when not on master [#371](https://github.com/intuit/auto/pull/371) ([@hipstersmoothie](https://github.com/hipstersmoothie)) +- shipit will publish a canary locally when not on `baseBranch` [#371](https://github.com/intuit/auto/pull/371) ([@hipstersmoothie](https://github.com/hipstersmoothie)) #### Authors: 1 diff --git a/docs/pages/docs/extras/label.md b/docs/pages/docs/extras/label.md index f54fa952c..afd755c4c 100644 --- a/docs/pages/docs/extras/label.md +++ b/docs/pages/docs/extras/label.md @@ -16,5 +16,5 @@ fi Running `auto label` without the PR number will: -- When run in master will get the labels for the last merged PR +- When run in `baseBranch` will get the labels for the last merged PR - When run for a PR in CI will use the PR's number diff --git a/docs/pages/docs/welcome/quick-merge.mdx b/docs/pages/docs/welcome/quick-merge.mdx index 7b9a9cf80..b5a0bb140 100644 --- a/docs/pages/docs/welcome/quick-merge.mdx +++ b/docs/pages/docs/welcome/quick-merge.mdx @@ -12,7 +12,7 @@ If you merge a PR while another is publishing: - they might try to publish the same version number - one will try to push over the other's changes and fail -> If you ensure that the last build on master has finished you shouldn't run into any problems! +> If you ensure that the last build on `baseBrach` has finished you shouldn't run into any problems! ### Beware Long Publishes diff --git a/packages/cli/README.md b/packages/cli/README.md index 097e9140b..c3b12525e 100644 --- a/packages/cli/README.md +++ b/packages/cli/README.md @@ -54,7 +54,7 @@ In the `Tag version` field enter the version number you just tagged and click `P The following are options that might be more useful to set in the `.autorc` than with a flag: ```txt - baseBranch Configure what your repo considers the "master" branch. + baseBranch Configure what your repo considers the base branch. plugins Specify your plugins to load githubApi If you are using enterprise github, `auto` lets you configure the github API URL that it uses. githubGraphqlApi If you are using enterprise github and your company hosts the graphql at some other URL than the diff --git a/plugins/vscode/README.md b/plugins/vscode/README.md index 234b2b4a0..31e3cc72c 100644 --- a/plugins/vscode/README.md +++ b/plugins/vscode/README.md @@ -44,7 +44,7 @@ Prepend all relative links in README.md with this url. "plugins": [ [ "vscode", - { "baseContentUrl": "https://github.com/my-username/my-repo/tree/master" } + { "baseContentUrl": "https://github.com/my-username/my-repo/tree/main" } ] // other plugins ] @@ -62,7 +62,7 @@ Prepend all relative image links in README.md with this url. [ "vscode", { - "baseContentUrl": "https://raw.githubusercontent.com/my-username/my-repo/master/" + "baseContentUrl": "https://raw.githubusercontent.com/my-username/my-repo/main/" } ] ]