You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/make-release.md
+20-6Lines changed: 20 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -270,6 +270,14 @@ Since Nerdbank.GitVersioning calculates the release version, the `AnalyzerReleas
270
270
4.**Commit the changes**
271
271
Commit the modifications before tagging the release.
272
272
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
+
273
281
### Example: First and Second Releases with Version Token
274
282
275
283
`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.
327
335
nbgv tag
328
336
```
329
337
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
+
330
344
> [!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.
332
346
333
347
#### Push the Release Branch to the Upstream Repository
334
348
335
349
The final step to begin the release build is to push the tag and any new commits to the upstream repository.
> 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.
343
357
344
358
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.
345
359
@@ -398,7 +412,7 @@ At the bottom of the draft release page, click on **Publish release**.
398
412
399
413
### Failed Draft Release
400
414
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.
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