Skip to content

Commit

Permalink
docs: Update contributing
Browse files Browse the repository at this point in the history
  • Loading branch information
Josh Larson committed Nov 20, 2020
1 parent 6d56e60 commit 1d78d6b
Showing 1 changed file with 2 additions and 33 deletions.
35 changes: 2 additions & 33 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,40 +6,9 @@ To report bugs or to request new features, you may [create a new issue](https://

## Releasing a New Version

Please use [semantic versioning](https://semver.org) when releasing new versions of the action, per [GitHub's recommendations](https://help.github.com/en/github/automating-your-workflow-with-github-actions/about-actions#versioning-your-action).
Please use [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) when contributing to the repository. If you've forgotten to use conventional commits, a maintainer can include the prefix in the merge commit when merging a PR.

After a new PR has been merged, you should promote unreleased changes in `CHANGELOG.md` to a new heading containing the new version and today's date.

Then, an engineer should run locally:

```bash
# pull down the latest changes
git checkout main && git pull

# build out the new dist code
yarn build

# commit it (where X.X.X is the new version)
git commit -am 'vX.X.X'

# tag the specific version (where X.X.X is the new version)
git tag -a vX.X.X -m 'vX.X.X'

# update the tag for the major version (where X is the major version)
# FIRST: delete the existing major version tag
git tag -d vX

# NEXT: re-add the major version tag
git tag vX

# FINALLY: remove the old major version tag from remote origin:
git push origin :refs/tags/vX

# push up the commit and the new tags
git push && git push --tags
```

Finally, issue a [new GitHub release](https://github.com/voxmedia/github-action-slack-notify-build/releases) for the corresponding version, detailing what has changed.
Releases happen automatically when merged into `main` with [semantic-release](https://semantic-release.gitbook.io/semantic-release/).

## Code of Conduct

Expand Down

0 comments on commit 1d78d6b

Please sign in to comment.