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: build/scripts/release/MAINTAINERS_GUIDE.md
+46-56Lines changed: 46 additions & 56 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@
6
6
7
7
### Create a GitHub tag
8
8
9
-
1. Get the new module version:
9
+
1.**Get the new module version:**
10
10
11
11
To choose the new version, you can use the [Semantic Versioning](https://semver.org/) scheme. The version number is in the format `X.Y.Z`, where:
12
12
-`X` is the *major* version number. Indicates significant **changes that may break backward compatibility** with previous versions (e.g., 1.0.0 to 2.0.0).
@@ -30,30 +30,30 @@
30
30
$RELEASE_TAG = "v${RELEASE_VERSION}"
31
31
```
32
32
33
-
> [!IMPORTANT]
34
-
> Ensure that the new version number is not already used in the [PowerShell Gallery][ctk-psg].
35
-
> If the version already exists, you will need to increment the version number.
36
-
> The PowerShell Gallery does not support permanent deletion of packages.
37
-
> Use the `Find-Module` command to check if the version already exists.
1. Cherry-pick the changes to a new branch from the main branch. The new branch name should be `release/X.Y.Z`, where `X.Y.Z` is the new version number.
56
+
3. **Cherry-pick the changes to a new branch** from the main branch. The new branch name should be `release/X.Y.Z`, where `X.Y.Z` is the new version number.
57
57
58
58
- Identify the commit hashes you want to include. You can find them using:
59
59
@@ -78,32 +78,20 @@
78
78
git cherry-pick --continue
79
79
```
80
80
81
-
1. Update the module version in the README.md file
82
-
83
-
*NOTE: Only update the version number in the README.md file for the latest release and not for pre-releases._*
84
-
85
-
1. Create a tag and a release in GitHub.
81
+
4. **Create a tag and a release in GitHub.**
86
82
87
83
```bash
88
84
git tag --sign "$RELEASE_TAG" -m "Release $RELEASE_TAG"
89
85
git push upstream "$BRANCH_NAME" --tags
90
86
```
91
87
92
-
> [!TIP]
93
-
> To delete an existing tag, use the following command:
> As of February 2025, GitHub does not have the option to only create a tag without creating a release. We therefore delete the release after creating the tag.
103
-
104
-
```bash
105
-
gh release delete -y $RELEASE_TAG
106
-
``` -->
88
+
> [!TIP]
89
+
> To delete an existing tag, use the following command:
90
+
>
91
+
> ```bash
92
+
> git tag --delete "$RELEASE_TAG"
93
+
> git push upstream :refs/tags/"$RELEASE_TAG"
94
+
> ```
107
95
108
96
### Create a release using the ADO release pipeline
109
97
@@ -128,24 +116,26 @@ Releases are created using the Containers-Toolkit ADO release pipeline. The rele
128
116
129
117
This publishes the module to the [PowerShell Gallery][ctk-psg] and creates a new release in GitHub.
0 commit comments