Skip to content

Commit

Permalink
GA on push: update package version (#8)
Browse files Browse the repository at this point in the history
* Create push.yml

* THC-444: update readme

---------

Co-authored-by: Volha Chamlai <[email protected]>
  • Loading branch information
VeiveHata and Volha Chamlai authored Sep 24, 2024
1 parent 19749c4 commit 288cf45
Show file tree
Hide file tree
Showing 2 changed files with 39 additions and 0 deletions.
21 changes: 21 additions & 0 deletions .github/workflows/push.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
name: Package version bump
on:
push:
branches:
- main

jobs:
bump:
name: Version bump
runs-on: ubuntu-latest
steps:

- name: Check out Git repository
uses: actions/checkout@v4

- name: Bump the version
uses: jpb06/bump-package@latest
with:
major-keywords: M,MAJOR,major
minor-keywords: m,minor
patch-keywords: fix,patch
18 changes: 18 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,6 +63,24 @@ $ pnpm install

Once you installed depedencies you are good to start development, no other action is required.


## Version update

Package version update is done automatically according to commit message. Check it here: [Bump package version](https://github.com/marketplace/actions/bump-package-version).

- there is no default version bump, be sure to provide correct commit message in case you want to update the version
- check different options for providing commit message for different [merge strategies](https://github.com/marketplace/actions/bump-package-version#-pull-requests)


For automatic version bump start you commit message with:

**MAJOR** - `M:`,` MAJOR:`, `major:`

**MINOR** - `m:`, `minor:`

**PATCH** - `fix:`, `patch:`


## Publication

To publish next version of this npm package first create a branch from `main`. Release branch should be named: `release-[versionTag]`, where `[versionTag]` is tag of version you want to publish.
Expand Down

0 comments on commit 288cf45

Please sign in to comment.