diff --git a/.autorc.json b/.autorc.json index a31946b..a1a7f14 100644 --- a/.autorc.json +++ b/.autorc.json @@ -5,5 +5,6 @@ "first-time-contributor", "released" ], - "onlyPublishWithReleaseLabel": true + "baseBranch": "stable", + "prereleaseBranches": ["next"] } diff --git a/.github/workflows/codeql-analysis.yml b/.github/workflows/codeql-analysis.yml index 1cffbe7..3fd3977 100644 --- a/.github/workflows/codeql-analysis.yml +++ b/.github/workflows/codeql-analysis.yml @@ -13,10 +13,10 @@ name: "CodeQL" on: push: - branches: [ main ] + branches: [ next ] pull_request: # The branches below must be a subset of the branches above - branches: [ main ] + branches: [ next ] schedule: - cron: '40 23 * * 1' diff --git a/.github/workflows/node.js.yml b/.github/workflows/node.js.yml index ea413c2..d66262c 100644 --- a/.github/workflows/node.js.yml +++ b/.github/workflows/node.js.yml @@ -5,9 +5,9 @@ name: Node.js CI on: push: - branches: [ main ] + branches: [ next ] pull_request: - branches: [ main ] + branches: [ next ] jobs: build: diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6b9965b..2ebdedd 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -25,3 +25,15 @@ yarn run commit ``` Consistent formatting allows us to keep the [changelog](./CHANGELOG.md) up to date automatically, and ensures future developers have a readable timeline of changes over time. For more information, see the [commitizen project page](https://github.com/commitizen/cz-cli). + +## How Publishing works + +## Publishing + +Publishing is handled by a 2-branch [pre-release process](https://intuit.github.io/auto/docs/generated/shipit#next-branch-default), configured in `release.yml`. All changes should be based off of the default `next` branch. Changes are automatically published to the `next` channel on NPM unless set to ignore via a `skip-release` Github label. + + +- PRs made into the default branch are deployed to the `next` pre-release tag on NPM. The result can be installed with `npm install @nteract/data-explorer@next`. + - When merging into `next`, please use the `create a merge commit` strategy. If `rebase` is used, auto won't be able to detect which PR introduced a particular set of commits.. +- To release a new `stable` on NPM (aka the `latest` tag), open a PR from `next` into `stable` using this [compare link](https://github.com/nteract/data-explorer/compare/stable...next). + - When merging from `next` into `stable`, please use the `create a merge commit` strategy.