Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

docs: extend readme #2

Merged
merged 1 commit into from
Jun 17, 2024
Merged

docs: extend readme #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,21 @@
# Example library for GitHub releases workshop

A simple Node.js library (with math-related utility functions). Serves to demonstrate **automated releases using semantic versioning**.

## Workflows

- [**CI** workflow](./.github/workflows/ci.yml) runs tests on push to any branch
- [**Release** workflow](./.github/workflows/release.yml) runs on every push to `main` branch
- determines next version from conventional commit messages
- if there aren't any changes impacting library consumers (`feat`, `fix` or `BREAKING CHANGE` commits), release is skipped
- new library version is published to GitHub Packages registry
- a new release commit is tagged with `vX.Y.Z` and pushed to `main` branch
- updates [`CHANGELOG.md`](./CHANGELOG.md) (generated from commit messages)
- updates `version` field in [`package.json`](./package.json)
- a new GitHub release is created with appropriate release notes

## Links

- [Package](https://github.com/flowup/releases-example-lib/pkgs/npm/releases-example-lib)
- [Releases](https://github.com/flowup/releases-example-lib/releases)
- [Actions](https://github.com/flowup/releases-example-lib/actions)