Skip to content

Commit

Permalink
docs: Update Readme with note on semantic-release
Browse files Browse the repository at this point in the history
  • Loading branch information
JimFawkes committed May 2, 2024
1 parent 56008d3 commit e8ef868
Showing 1 changed file with 4 additions and 1 deletion.
5 changes: 4 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,7 @@ This template comes with:
In order for semantic release to work properly, two steps are necessary:

1. All commits need to honor [conventional-commits](https://www.conventionalcommits.org/en/v1.0.0/)
2. The GitHub Actions need read & write permissions (Settings > Actions > Permissions)
2. The GitHub Actions need read & write permissions (Settings > Actions > General > Workflow Permissions)

Note that semantic-release always start with version 1.0.0 once the first conventional commit is pushed to the main branch.
If this is not the desired behaviour, you should disable the semantic-release action until you are ready to release the first version.

0 comments on commit e8ef868

Please sign in to comment.