diff --git a/.github/workflows/merge-dependabot.yml b/.github/workflows/merge-dependabot.yml index 027bd26a..4fb46f6c 100644 --- a/.github/workflows/merge-dependabot.yml +++ b/.github/workflows/merge-dependabot.yml @@ -13,4 +13,4 @@ jobs: with: token: ${{ secrets.GITHUB_TOKEN }} auto-merge: 'minor' - merge-method: 'rebase' + merge-method: 'squash' diff --git a/.github/workflows/publish.yml b/.github/workflows/publish.yml index 4ac2a4bc..2934eab0 100644 --- a/.github/workflows/publish.yml +++ b/.github/workflows/publish.yml @@ -29,6 +29,6 @@ jobs: - name: Create release env: - GH_TOKEN: ${{ secrets.GH_PAT }} + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} NPM_TOKEN: ${{ secrets.NPM_TOKEN }} run: yarn run release diff --git a/README.md b/README.md index 2a5cb093..f8b4d0f3 100644 --- a/README.md +++ b/README.md @@ -75,9 +75,11 @@ See the [API documentation](docs/APIs.md) for details. 2. Then, type `yarn start`. This will build the library and start a web server. 3. In your browser, navigate to `http://localhost:8000/`, where you can see various Vega-Lite and Vega visualizations with tooltip interaction. -## Publish +## Publishing Publishing is handled by a 2-branch [pre-release process](https://intuit.github.io/auto/docs/generated/shipit#next-branch-default), configured in `publish.yml`. All changes should be based off the default `next` branch, and are published automatically. -- PRs made into the default branch are auto-deployed to the `next` pre-release tag on NPM. The result can be installed with `npm install vega-tooltip/@next` +- PRs made into the default branch are auto-deployed to the `next` pre-release tag on NPM. The result can be installed with `npm install vega-tooltip/@next`. + - When merging into `next`, please use the `squash and merge` strategy. - To release a new stable version, open a PR from `next` into `stable` using this [compare link](https://github.com/vega/vega-tooltip/compare/stable...next). + - When merging from `next` into `stable`, please use the `create a merge commit` strategy.