Skip to content

Commit

Permalink
Improve README
Browse files Browse the repository at this point in the history
  • Loading branch information
gandarez committed Oct 23, 2024
1 parent c970762 commit 3923a26
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 18 deletions.
34 changes: 17 additions & 17 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,12 +137,12 @@ Uses `auto` bump strategy to calculate the next semantic version.
prerelease_id: "alpha"
main_branch_name: "main"
develop_branch_name: "dev"
patch_regex: "^fix/.+"
minor_regex: "^feat/.+"
major_regex: "^major/.+"
build_regex: "^build/.+"
hotfix_regex: "^hotfix/.+"
exclude_regex: "^ignore/.+"
patch_pattern: "^fix/.+"
minor_pattern: "^feat/.+"
major_pattern: "^major/.+"
build_pattern: "^build/.+"
hotfix_pattern: "^hotfix/.+"
exclude_pattern: "^ignore/.+"
- name: "Created tag"
run: echo "tag ${{ steps.semver-tag.outputs.semver_tag }}"
```
Expand All @@ -169,11 +169,11 @@ Uses `auto` bump strategy to calculate the next semantic version.
branching_model: "trunk-based"
prefix: "ver"
main_branch_name: "main"
patch_regex: "^fix/.+"
minor_regex: "^feat/.+"
major_regex: "^major/.+"
build_regex: "^build/.+"
exclude_regex: "^ignore/.+"
patch_pattern: "^fix/.+"
minor_pattern: "^feat/.+"
major_pattern: "^major/.+"
build_pattern: "^build/.+"
exclude_pattern: "^ignore/.+"
- name: "Created tag"
run: echo "tag ${{ steps.semver-tag.outputs.semver_tag }}"
```
Expand All @@ -189,12 +189,12 @@ Uses `auto` bump strategy to calculate the next semantic version.
| prerelease_id | false | Text representing the prerelease identifier. | pre |
| main_branch_name | false | The main branch name. | master |
| develop_branch_name | false | The develop branch name. | develop |
| patch_regex | false | Patch regex to match branch name for patch increment. | (?i)^(.+:)?(bugfix/.+) |
| minor_regex | false | Minor regex to match branch name for minor increment. | (?i)^(.+:)?(feature/.+) |
| major_regex | false | Major regex to match branch name for major increment. | (?i)^(.+:)?(release/.+) |
| build_regex | false | Build regex to match branch name for build increment. | (?i)^(.+:)?((doc(s)?|misc)/.+) |
| hotfix_regex | false | Hotfix regex to match branch name for patch increment. | (?i)^(.+:)?(hotfix/.+) |
| exclude_regex | false | Regex to exclude branches from semantic versioning. | |
| patch_pattern | false | Patch pattern to match branch name for patch increment. | (?i)^(.+:)?(bugfix/.+) |
| minor_pattern | false | Minor pattern to match branch name for minor increment. | (?i)^(.+:)?(feature/.+) |
| major_pattern | false | Major pattern to match branch name for major increment. | (?i)^(.+:)?(release/.+) |
| build_pattern | false | Build pattern to match branch name for build increment. | (?i)^(.+:)?((doc(s)?|misc)/.+) |
| hotfix_pattern | false | Hotfix pattern to match branch name for patch increment. | (?i)^(.+:)?(hotfix/.+) |
| exclude_pattern | false | Pattern to exclude branches from semantic versioning. | |
| repo_dir | false | The repository path. | current dir |
| debug | false | Enable debug mode. | false |

Expand Down
4 changes: 3 additions & 1 deletion cmd/generate/params_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -373,6 +373,7 @@ func TestLoadParams_String(t *testing.T) {
os.Setenv("INPUT_BUILD_PATTERN", "^build/.+")
os.Setenv("INPUT_HOTFIX_PATTERN", "^hotfix/.+")
os.Setenv("INPUT_EXCLUDE_PATTERN", "^ignore/.+")
os.Setenv("INPUT_DEBUG", "true")

defer func() {
os.Unsetenv("INPUT_BUMP")
Expand All @@ -389,6 +390,7 @@ func TestLoadParams_String(t *testing.T) {
os.Unsetenv("INPUT_BUILD_PATTERN")
os.Unsetenv("INPUT_HOTFIX_PATTERN")
os.Unsetenv("INPUT_EXCLUDE_PATTERN")
os.Unsetenv("INPUT_DEBUG")
}()

params, err := generate.LoadParams()
Expand All @@ -408,6 +410,6 @@ func TestLoadParams_String(t *testing.T) {
` hotfix pattern "^hotfix/.+",`+
` exclude pattern: "^ignore/.+",`+
` repo dir: "/var/tmp/project",`+
` debug: false`,
` debug: true`,
params.String())
}

0 comments on commit 3923a26

Please sign in to comment.