Skip to content

Commit

Permalink
doc: note about skip-release
Browse files Browse the repository at this point in the history
That's because the merge commit might contain files from prior commits to the release branch. Without this label, these files would be considered as changes to be released (again).
  • Loading branch information
restfulhead committed Feb 16, 2024
1 parent cd02727 commit b754833
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions .vscode/launch.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,13 @@
"name": "Auto changelog",
"type": "node",
"request": "launch",
"cwd": "${workspaceFolder}/packages/filter-by-workspace-path",
"cwd": "${workspaceFolder}/packages/example-test-package",
"program": "${workspaceFolder}/node_modules/auto/dist/bin/auto",
"args": [
"changelog",
"-d",
"-v"
"--from",
"@restfulhead/npm-auto-plugin-example-test-package_v0.0.2"
],
"internalConsoleOptions": "openOnSessionStart",
"sourceMaps": true,
Expand Down
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,5 +14,5 @@ A collection of plugins for [Intuit's auto package](https://github.com/intuit/au
2. Periodically merge changes from the `main` branch into your feature branch
3. When ready, create a pull request and label it with an appropriate release label such as `release-patch`.
4. After code review, merge your pull request into the `main` branch.
5. When ready to release, create a pull request from `main` to `release` (label it with `release-internal`)
5. When ready to release, create a pull request from `main` to `release`. *Important*: Label this PR with `skip-release`.
6. When the PR is merged, packages with changes will be automatically released.

0 comments on commit b754833

Please sign in to comment.