File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change @@ -2,7 +2,8 @@ name: Version Bumper
22
33description : |
44 A reusable GitHub Action to automatically bump the version of a project based on pull request labels.
5- It uses the `bump` gem to handle versioning and tagging.
5+ It uses the `bump` gem to handle versioning and tagging. Though implemented in Ruby, it can be used
6+ with any language or project type.
67
78 This action is triggered when called by another workflow after a pull request is merged into the main branch.
89 It determines the version bump type (major, minor, patch) based on the labels applied to the pull request.
@@ -13,7 +14,11 @@ description: |
1314 and "Version Bump: Skip" labels in your repository to use this action effectively.
1415
1516 The action updates version strings in the files specified by the `version_file_patterns` input parameter.
16- You may use glob patterns. Files that do not exist will be ignored with a warning.
17+ You may use glob patterns. Files that do not exist will be ignored with a warning. The file VERSION
18+ is detected automatically.
19+
20+ Most of the complexity of this action is in the file processing and label-reading logic; the actual version
21+ bumping is entriely handled by the `bump` gem.
1722
1823 Example usage:
1924 ```yaml
2934 workflow_call :
3035 inputs :
3136 version_file_patterns :
32- description : ' List of file patterns to search for version strings (one pattern per line)'
37+ description : ' List of file patterns to search for version strings (one pattern per line). VERSION is detected automatically. '
3338 required : false
3439 type : string
3540 default : ' lib/*/version.rb'
You can’t perform that action at this time.
0 commit comments