https://github.com/flowup/releases-example-lib

Example library for GitHub releases workshop
https://github.com/flowup/releases-example-lib

Last synced: about 1 year ago
JSON representation

Example library for GitHub releases workshop

• Host: GitHub
• URL: https://github.com/flowup/releases-example-lib
• Owner: flowup
• License: mit
• Created: 2024-06-14T08:02:04.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-06-17T14:09:33.000Z (about 2 years ago)
• Last Synced: 2025-02-15T16:52:06.907Z (over 1 year ago)
• Language: JavaScript
• Size: 65.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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)