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
Revise release creation steps in documentation (#2487)
* Revise release creation steps in documentation
Updated steps for creating a new release, including changes to the tagging and release notes process.
* Fix MD040: add language specifier to fenced code block
Agent-Logs-Url: https://github.com/dotnet/iot/sessions/f6099354-d13d-4e96-a286-634c7007211f
Co-authored-by: krwq <660048+krwq@users.noreply.github.com>
---------
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: krwq <660048+krwq@users.noreply.github.com>
Copy file name to clipboardExpand all lines: Documentation/creating-new-release.md
+11-12Lines changed: 11 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,29 +8,28 @@ This is a list of steps which need to happen in order to release new version of
8
8
9
9
- Step 1: Ensure all PRs meant for this release are merged.
10
10
- While the process is ongoing, make sure no new PRs get merged in order to ensure that the official build doesn't get reset.
11
-
- Step 2: Regenerate device listing:
11
+
- Step 2: Regenerate device listing - this can be done with copilot:
12
12
-`dotnet run` on <https://github.com/dotnet/iot/tree/main/tools/device-listing>
13
13
- Fix all warnings, re-run if needed to ensure no warnings.
14
14
- Always manually review the changes paying attention the generated document looks clear.
15
15
- Adjust categories/code of the generator if necessary.
16
16
- Step 3: Create new package:
17
17
- Go to <https://dev.azure.com/dotnet/IoT/_build?definitionId=179>
18
-
- Select "Run Pipeline", select row which says `variables` and add new one: `DotNetFinalVersionKind=release` (no quotes anywhere).
18
+
- Select "Run Pipeline", select row which says `variables`change `DotNetFinalVersionKind`and set value to `release` (no quotes anywhere).
19
19
- Run and wait for it to finish.
20
20
- Once it is done and passes go to the artifacts section of the build, and find an artifact called 'Built packages' and from there download the two stable packages.
21
21
- Validate the package: double check version, check there are no unintentional changes.
22
22
- Step 4: Manually push package to Nuget - people who had access to push in the past: @joperezr@rbhanda
23
23
- Step 5: Add git tag:
24
-
- Use `git tag -a <version> <commit_hash>` to locally create a tag.
25
-
- Use `git push origin <version>` to push it (`<version>` is i.e. `1.3`).
- Copy the list of commits, clean those related to dependencies update.
29
-
- Use i.e.: <https://github.com/dotnet/iot/compare/1.1...1.2> to see list of commits.
30
-
- Categorize them by: `System.Gpio`, `Iot.Device.Bindings`, `Other` changes.
31
-
- Rephrase/group them for consistency.
32
-
- Add the list of contributors ordered by the number of commits or alphabetically. Command: `git shortlog -s 1.4..1.5` is very helpful but doesn't give github user names
33
-
- Step 7: After package is pushed to Nuget create a PR similar to <https://github.com/dotnet/iot/pull/1310> to prepare for next release.
24
+
- Use `git tag -a <version> <commit_hash>` to locally create a tag, if on latest locally you can also use `HEAD` instead of commit hash but do ensure you've synced your changes.
25
+
- Use `git push origin <version>` to push it (`<version>` is i.e. `v4.1.0`).
26
+
- Step 6: Create and generate release notes on github from tag: <https://github.com/dotnet/iot/releases/new>
27
+
- Step 7: After package is pushed to Nuget create a PR similar to <https://github.com/dotnet/iot/pull/2464> to prepare for next release. You can adjust following copilot prompt to generate it:
28
+
29
+
```text
30
+
Prepare PR similar to https://github.com/dotnet/iot/pull/2464 for next version: 4.3.0
31
+
```
32
+
34
33
- Step 8: Update dependencies on old version of the package:
35
34
- Option 1: Wait for `dependabot` to automatically create dependencies update PR (similar to: [System.Device.Gpio](https://github.com/dotnet/iot/pulls?q=is%3Apr+Bump+System.Device.Gpio+is%3Aclosed+author%3Aapp%2Fdependabot); [Iot.Device.Bindings](https://github.com/dotnet/iot/pulls?q=is%3Apr+Bump+Iot.Device.Bindings+is%3Aclosed+author%3Aapp%2Fdependabot))
36
35
- Options 2: Alternatively update versions manually to avoid swarm of PRs.
0 commit comments