Skip to content

Commit 3e351a3

Browse files
committed
DEVOPS-00: Update README.
1 parent c35ef92 commit 3e351a3

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# GitOps Automatic Versioning
1+
# Introduction
22

33
![build](https://img.shields.io/github/workflow/status/AlexAtkinson/github-action-gitops-autover/Build?logo=github&style=for-the-badge)
44
![version](https://img.shields.io/github/v/release/AlexAtkinson/github-action-gitops-autover?style=for-the-badge)
55
![license](https://img.shields.io/github/license/AlexAtkinson/github-action-gitops-autover?style=for-the-badge)
66
![repo size](https://img.shields.io/github/repo-size/AlexAtkinson/github-action-gitops-autover?style=for-the-badge)
77

8-
Language/content agnostic method of automatically determining the [semantic version](https://semver.org/) for a product based on merge history with MINIMAL discipline dependencies.
8+
Language/content agnostic method of automatically determining the [semantic version](https://semver.org/) for a product based on _branch_ merge history with MINIMAL discipline dependencies.
99

10-
This is accomplished by counting the merges for 'enhancement/.\*', 'feature/.\*', 'fix/.\*', 'bugfix/.\*', 'hotfix/.\*', 'ops/.\*' branches into either the 'main' or 'master' branch. Folks familiar with Scrum/SAFe or GitFlow/.*Flow branching strategies will recognize this scheme.
10+
This is accomplished by counting the merges of branches matching the [naming scheme](#branch-naming-scheme) into either the [main|master] branch. Folks familiar with Scrum/SAFe or GitFlow/fooFlow strategies will recognize this scheme.
1111

1212
**Yes**, this can be implemented in repos that previously used different version increment methods.
1313

@@ -33,7 +33,12 @@ git push --tags</pre></dd>
3333
npm version $NEW_VERSION</pre></dd>
3434
<dd>4. Tag the repo with the new version at some point in the workflow.
3535
<dt>Team Setup</dt>
36-
<dd>5. Ensure the iteration team adheres to the branch naming scheme defined below.</dd>
36+
<dd>5. Ensure the iteration team adheres to the branch naming scheme defined below. Here's an example workflow.</dd>
37+
<dd><pre>
38+
git checkout -b fix/not-a-feature
39+
git commit --allow-empty -m "This was a bug and not a feature after all..."
40+
git push --set-upstream origin fix/not-a-feature
41+
# THEN: Click the link to create a PR & merge it</pre></dd>
3742
</dl>
3843

3944
### Outputs
@@ -89,9 +94,14 @@ _minor:_
8994
> Q: _How did you execute 103 merges?_<br>
9095
A: You can use the bump scripts in the scripts directory of this<br>
9196
repo, like: './scripts/bumpPatch.sh 42'<br>
97+
(Does not work with branch protection enabled)
98+
99+
> NOTE: This repo uses its own action for versioning, so feel free to investigate that workflow for another example.
92100
93101
## Discipline Dependency
94102

103+
### Branch Naming Scheme
104+
95105
This action depends _only_ on the following _branch naming scheme_ being observed.
96106

97107
| Branch Name | Increment | Description |
@@ -189,4 +199,4 @@ PR's welcome...
189199
- Specifying custom branch names to indicate MINOR and PATCH versions.
190200
- Subdirectory specific versioning.
191201
- Full GH Actions Workflow Example, including tagging and GH release.
192-
- CAN'T DO: unshallow from last version tag to latest commit to... Seems a limitation of (git at first glance).
202+
- CAN'T DO: unshallow from last version tag to latest commit to... Seems a limitation of (git at first glance).

0 commit comments

Comments
 (0)