Skip to content

Commit

Permalink
docs: clarify versioning mechanism
Browse files Browse the repository at this point in the history
  • Loading branch information
edouard-lopez committed Dec 1, 2023
1 parent edae06c commit b55b849
Showing 1 changed file with 6 additions and 3 deletions.
9 changes: 6 additions & 3 deletions RELEASE.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,13 @@ We run the test workflow on:
* `**.fish` files with the exception `conf.d/pure.fish`, as we have dedicated mechanism to manage versions bump ;
* and workflow (`*.yml`) files

## Bumping version
## Versioning

**required:** You MUST **follow semantic versioning** based on [conventional commits][coco].
**required:** Commits must **[follow conventional commits convention][coco]**.

Is triggered only on `master` and:
Versioning is done automatically based on commit messages and triggered only on `master` branch.

Details:

1. We compute the [project's next version][next-version] using a GitHub Action ;
2. Then update `$pure_version` value in `./conf.d/pure.fish` ;
Expand All @@ -29,3 +31,4 @@ The `add-version-tag.yml` pipeline is triggered only for `master` when `./conf.d

[next-version]: https://github.com/thenativeweb/get-next-version
[push]: https://github.com/ad-m/github-push-action
[coco]: https://www.conventionalcommits.org/en/v1.0.0/

0 comments on commit b55b849

Please sign in to comment.