Skip to content

Commit 7186fac

Browse files
committed
docs/make-release.md: Changed docs to reflect the fact that release builds are made from git tags rather than branches.
1 parent 5bcf37f commit 7186fac

File tree

1 file changed

+20
-6
lines changed

1 file changed

+20
-6
lines changed

docs/make-release.md

Lines changed: 20 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -270,6 +270,14 @@ Since Nerdbank.GitVersioning calculates the release version, the `AnalyzerReleas
270270
4. **Commit the changes**
271271
Commit the modifications before tagging the release.
272272

273+
```console
274+
git add -A
275+
git commit -m "Updated AnalyzerReleases with the latest changes"
276+
```
277+
278+
> [!NOTE]
279+
> To ensure the Git commit hook works correctly, run these commands on the command line. Some GUI tools may interfere with it.
280+
273281
### Example: First and Second Releases with Version Token
274282

275283
`AnalyzerReleases.Shipped.md` evolves by appending each release as a new section. Each release is marked with a `## Release <version>` header.
@@ -327,19 +335,25 @@ Run the following command to tag the HEAD commit of the release branch.
327335
nbgv tag
328336
```
329337

338+
This command will reply with the tag name and release commit hash.
339+
340+
```console
341+
v1.0.0-alpha.155 tag created at bd65d5e12b6ed44ba478b8f564dd3f19799dfbf4.
342+
```
343+
330344
> [!NOTE]
331-
> The release build workflow always builds from the HEAD commit of the release branch.
345+
> The release build workflow always builds from the tag, not the HEAD commit. To ensure all commits on the branch make it into the release, ensure that the tag is pointing to the HEAD commit.
332346
333347
#### Push the Release Branch to the Upstream Repository
334348

335349
The final step to begin the release build is to push the tag and any new commits to the upstream repository.
336350

337351
```console
338-
git push <remote-name> <release-branch> --follow-tags
352+
git push <remote-name> <release-branch> <tag-name>
339353
```
340354

341-
> [!NOTE]
342-
> If there are any local commits that have not yet been pushed, the above command will include them in the release.
355+
> [!IMPORTANT]
356+
> If there are any local commits that have not yet been pushed, the above command will include them in the release. The command provided as a hint from `nbgv tag` does not include the branch name, but we should always push the branch as well as the tags to put the upstream repository in a consistent state.
343357
344358
The push will start the automated draft release which will take a few minutes. When completed, there will be a new draft release in the [GitHub Releases](https://github.com/apache/lucenenet-codeanalysis-dev/releases) corresponding to the version you tagged.
345359

@@ -398,7 +412,7 @@ At the bottom of the draft release page, click on **Publish release**.
398412

399413
### Failed Draft Release
400414

401-
If the build failed in any way, the release can be restarted by deleting the tag and trying again. First check to see the reason why the build failed in the [GitHub Actions UI](https://github.com/apache/lucenenet-codeanalysis-dev/actions) and correct any problems that were reported.
415+
If the build failed in any way, the release can be restarted by deleting the tag and trying again. First check to see the reason why the build failed in the [GitHub Actions UI](https://github.com/apache/lucenenet-codeanalysis-dev/actions) and correct any problems that were reported. Make any necessary commits to the release branch before starting the release.
402416

403417
#### Restarting the Draft Release
404418

@@ -454,4 +468,4 @@ git push --delete <remote-name> <release-branch>
454468

455469
### Update Lucene.NET
456470

457-
The Lucene.NET project is the only consumer of this package. If the release was intended for general use (not just a one-off scan), update the version in `Dependencies.props` to reflect the new release and submit a pull request to [the Lucene.NET repository](https://github.com/apache/lucenenet).
471+
The Lucene.NET project is the only consumer of this package. If the release was intended for general use (not just a one-off scan), update the version in `.build/dependencies.props` to reflect the new release and submit a pull request to [the Lucene.NET repository](https://github.com/apache/lucenenet).

0 commit comments

Comments
 (0)