Skip to content

Commit

Permalink
docs: improve Release Me Run Guide UX, by using icons
Browse files Browse the repository at this point in the history
  • Loading branch information
boromir674 committed Aug 18, 2024
1 parent 39ce425 commit 1bda796
Showing 1 changed file with 12 additions and 10 deletions.
22 changes: 12 additions & 10 deletions docs/guides/gitops/run/guide_run_gitops_release_me_process.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,17 +46,17 @@ This is a `how-to` Guide, with everything you need, to "run" the
<!-- <div class="annotate" markdown> -->
1. Fire-up `release-me` git tag event
1. :octicons-tag-24: Fire-up `release-me` git tag event
```sh
export _tag=release-me
git tag -d "$_tag"; git push --delete origin "$_tag";
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
Expand All @@ -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:
<div class="grid cards" markdown>
Expand All @@ -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__
---
- `<M.m.p\>` for Public Changes
- `<M.m.p>` for Public Changes
Eg: `1.0.0`, `1.2.1`, `0.5.0`
- <M.m.p-dev\d?\> for Private Changes
- `<M.m.p-dev\d?\>` for Private Changes
Eg: `1.0.1-dev`, `1.2.1-dev2`,
`0.5.0-dev1`
Expand All @@ -101,7 +103,7 @@ This is a `how-to` Guide, with everything you need, to "run" the
<div class="annotate" markdown>
<ol start="5">
<li>Update Changelog (1)<pre><code>code CHANGELOG.md</pre></code><pre><code class="language-sh"><span id="semver-output2">git add CHANGELOG.md && commit -m "chore(changelog): add v... Changelog Release Entry"</span></pre></code></li>
<li>Update Changelog (1)<pre><code>code CHANGELOG.md</pre></code><pre><code class="language-sh"><span id="semver-output2">git add CHANGELOG.md && commit -m "chore(changelog): add v... Changelog Release Entry"</span></pre></code><pre><code>git push origin release</pre></code></li>
<li>If you maintain the Sem Ver in your source files, <strong>update Sem Ver in sources (2)</strong></li>
<li>Fire-up an <code>auto-prod-&lt;sem ver&gt;</code> git tag event (ie <code>auto-prod-1.2.0</code>)
Expand Down

0 comments on commit 1bda796

Please sign in to comment.