diff --git a/docs/guides/gitops/run/guide_run_gitops_release_me_process.md b/docs/guides/gitops/run/guide_run_gitops_release_me_process.md index 5487a6b..6fe60e3 100644 --- a/docs/guides/gitops/run/guide_run_gitops_release_me_process.md +++ b/docs/guides/gitops/run/guide_run_gitops_release_me_process.md @@ -46,7 +46,7 @@ This is a `how-to` Guide, with everything you need, to "run" the -1. Fire-up `release-me` git tag event +1. :octicons-tag-24: Fire-up `release-me` git tag event ```sh export _tag=release-me @@ -54,9 +54,9 @@ This is a `how-to` Guide, with everything you need, to "run" the git tag "$_tag" && git push origin "$_tag" ``` -2. Wait for PR to open against *base* `main` branch, from *head* `release` branch +2. :material-source-pull: Wait for PR to open against *base* `main` branch, from *head* `release` branch -3. Sync `release` branch to local checkout +3. :material-sync: Sync `release` branch to local checkout ```sh export release=release @@ -69,11 +69,9 @@ This is a `how-to` Guide, with everything you need, to "run" the git pull origin "${release}" ``` -4. Derive Release Semantic Version +4. :simple-semanticrelease: Derive Release Semantic Version - To help you decide on the Version Bump (`Current_Version + Version_Bump = New_Version`), see the [Decision Diagram](../../../topics/semantic-release.md#semantic-release-version-bump), or read more on the [Semantic Release Topic](../../../topics/semantic-release.md) - - Please enter the new **Semantic Release Version**, you intend to publish: + **Please enter** the new **Semantic Release Version**, you intend to publish:
@@ -83,15 +81,19 @@ This is a `how-to` Guide, with everything you need, to "run" the Input Release Semantic Version; ie 1.2.1 + - Get help in **determining Version Bump**, from the [:material-arrow-decision: Decision Diagram](../../../topics/semantic-release.md#semantic-release-version-bump) + - Read more on [:octicons-book-16: Semantic Release Topic](../../../topics/semantic-release.md) + + - :material-clock-fast:{ .lg .middle } __Automation currently supports__ --- - - `` for Public Changes + - `` for Public Changes Eg: `1.0.0`, `1.2.1`, `0.5.0` - - for Private Changes + - `` for Private Changes Eg: `1.0.1-dev`, `1.2.1-dev2`, `0.5.0-dev1` @@ -101,7 +103,7 @@ This is a `how-to` Guide, with everything you need, to "run" the
    -
  1. Update Changelog (1)
    code CHANGELOG.md
    git add CHANGELOG.md && commit -m "chore(changelog): add v... Changelog Release Entry"
  2. +
  3. Update Changelog (1)
    code CHANGELOG.md
    git add CHANGELOG.md && commit -m "chore(changelog): add v... Changelog Release Entry"
    git push origin release
  4. If you maintain the Sem Ver in your source files, update Sem Ver in sources (2)
  5. Fire-up an auto-prod-<sem ver> git tag event (ie auto-prod-1.2.0)