Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mzogheib/gh-actions-publish-test
https://github.com/mzogheib/gh-actions-publish-test
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/mzogheib/gh-actions-publish-test
- Owner: mzogheib
- Created: 2023-10-20T22:22:32.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2023-12-04T00:50:27.000Z (about 1 year ago)
- Last Synced: 2023-12-04T05:39:11.371Z (about 1 year ago)
- Language: Shell
- Size: 132 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Tag, release & publish automation
## Summary
This project demonstrates the setup required for tag, release & publish automation.
## Development process
1. Develop on feature branches
2. Merge to `main`
3. Release PR is created automatically and updated as more commits are made on `main`
4. Manually merge the PR, which automatically creates the tag and release notes
5. New version of the package is automatically published to NPM
## Solution
### Summary
- All commits on `main` adhere to [Conventional Commits](https://www.conventionalcommits.org)
- On every push to `main` GitHub Actions workflows parse those commits then tag, release and publish the package as required
### Details
- Configure a pre-commit hook to enforce commit message syntax
- https://github.com/conventional-changelog/commitlint
- Enforce on the `main` branch only
- Not required if `main` is protected but good to be safe
- Configure GitHub to enforce PR title syntax
- https://github.com/marketplace/actions/semantic-pull-request
- Enforce for PRs on the `main` branch only
- Create a workflow to automatically create a release PR on push to `main`
- https://github.com/google-github-actions/release-please-action
- Leverages the PR title syntax described above
- **Note:** a release PR will only be created for releasable units, which are commits pre-fixed with:
```sh
# minor
feat:
# patch
fix:
perf:
refactor:
```
or breaking changes, which include a `!`:
```bash
# major
refactor!:
fix!:
# etc.
```
- Extend the workflow to publish to NPM after the release PR has been merged
- Create a separate action to run `npm publish`
- Call this action when the `release_created` output from `release-please-action` is `true`
### GitHub settings
- Give GitHub Actions write access
- Settings > Actions > General > Workflow permissions
- Select _"Read and write permissions"_
- Select _"Allow GitHub Actions to create and approve pull requests"_
- Enforce squashed merges
- Settings > General > Pull Requests
- De-select _"Allow merge commits"_
- Add branch protection to `main`
- Require a pull request before merging
- Require status checks to pass before merging
- Search for and select the action associated to the required status
- Require branches to be up to date before merging
- Require linear history