Skip to content

Commit ab7f0b1

Browse files
committed
docs/make-release: Added workflow for release build outcomes. Also corrected release branching info to show branches with 3 version components.
1 parent c26a0c9 commit ab7f0b1

4 files changed

Lines changed: 142 additions & 4 deletions

File tree

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
This markup can be edited and converted to .svg or .png here:
2+
https://www.mermaidchart.com/app/projects/95759d78-db93-499c-ad66-0e3f698ba88c/diagrams/31dbd6bc-7ec8-4583-a456-55e3fe3f6cfc/version/v0.1/edit
3+
4+
```mermaid
5+
flowchart TD
6+
A[Tag + Push release branch] --> B{Draft Release generated?}
7+
B -- Yes --> C[Review release notes]
8+
C --> D[Check release artifacts]
9+
D --> E[Publish Release to NuGet.org]
10+
11+
B -- No --> F[Check GitHub Actions logs]
12+
F --> G[Fix problems]
13+
G --> H[Delete failed tag]
14+
H --> I["Reset AnalyzerReleases.Shipped.md<br/>header to {{vnext}} if needed"]
15+
I --> A
16+
```

docs/images/release-build-outcomes.svg

Lines changed: 102 additions & 0 deletions
Loading

docs/images/release-workflow.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
This markup can be edited and converted to .svg or .png here:
2+
https://www.mermaidchart.com/app/projects/95759d78-db93-499c-ad66-0e3f698ba88c/diagrams/35faa26e-5ccf-4433-962e-32f20496471c/version/v0.1/edit
3+
4+
```mermaid
5+
flowchart LR
6+
main[Main Branch]
7+
release[Release Branch]
8+
tag[Git Tag]
9+
draft[Draft Release]
10+
publish[Publish Release]
11+
12+
main -->|Prepare Release| release
13+
release -->|Tag Version| tag
14+
tag --> draft
15+
draft -->|Manual Review| publish
16+
```

docs/make-release.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -101,11 +101,11 @@ nbgv prepare-release --nextVersion 2.0.1
101101
The command should respond with:
102102

103103
```console
104-
release/v2.0 branch now tracks v2.0.0 stabilization and release.
104+
release/v2.0.0 branch now tracks v2.0.0 stabilization and release.
105105
main branch now tracks v2.0.1-alpha.{height} development.
106106
```
107107

108-
The tool created a release branch named `release/v2.0`. Every build from this branch will be versioned 2.0.x, but the patch version may be incremented depending on the number of additional commits that will be added.
108+
The tool created a release branch named `release/v2.0.0`. Every build from this branch will be versioned 2.0.0, regardless of how many commits are added.
109109

110110
### Requires Stabilization
111111

@@ -118,11 +118,11 @@ nbgv prepare-release beta --nextVersion 2.0.1
118118
The command should respond with:
119119

120120
```console
121-
release/v2.0 branch now tracks v2.0.0-beta.{height} stabilization and release.
121+
release/v2.0.0 branch now tracks v2.0.0-beta.{height} stabilization and release.
122122
main branch now tracks v2.0.1-alpha.{height} development.
123123
```
124124

125-
The tool created a release branch named `release/v2.0`. Every build from this branch will be given a unique pre-release version starting with 2.0.0-beta and ending in a dot followed by one or more digits.
125+
The tool created a release branch named `release/v2.0.0`. Every build from this branch will be given a unique pre-release version starting with 2.0.0-beta and ending in a dot followed by one or more digits.
126126

127127
---------------------------------------------
128128

@@ -235,6 +235,10 @@ The release process is mostly automated. However, a manual review is required on
235235
4. Abort the release to try again
236236
5. Publish the release to deploy the packages to NuGet.org
237237

238+
<p align="center">
239+
<img src="images/release-build-outcomes.svg" alt="Release Build Outcomes" width="40%" align="center" />
240+
</p>
241+
238242
### Create a Draft Release
239243

240244
Tagging the commit and pushing it to the GitHub repository will start the automated draft release. The progress of the release can be viewed in the [GitHub Actions UI](https://github.com/apache/lucenenet-codeanalysis-dev/actions). Select the run corresponding to the version tag that is pushed upstream to view the progress.

0 commit comments

Comments
 (0)