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
* chore(CRC-236): Bump @tid-xcut/markdown-confluence-sync from 1.1.0 to 1.1.1 (Fix preprocess hook)
* Update .github/CONTRIBUTING.md
Co-authored-by: Miguel José Martínez Cordón <[email protected]>
---------
Co-authored-by: Miguel José Martínez Cordón <[email protected]>
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+34-26Lines changed: 34 additions & 26 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -105,32 +105,40 @@ But we use the __merge commit strategy for merging PRs to the main branch from t
105
105
106
106
# Release process
107
107
108
-
Once the PR is approved and merged into the main branch, a project maintainer can start the release process by tagging the main branch with the corresponding version numbers.
109
-
110
-
This project includes a helper script, [`script/release`](./script/release)
111
-
designed to streamline the process of tagging and pushing new releases for
112
-
GitHub Actions.
113
-
114
-
GitHub Actions allows users to select a specific version of the action to use,
115
-
based on release tags. This script simplifies this process by performing the
116
-
following steps:
117
-
118
-
1. **Retrieving the latest release tag:** The script starts by fetching the most
119
-
recent SemVer release tag of the current branch, by looking at the local data
120
-
available in your repository.
121
-
1. **Prompting for a new release tag:** The user is then prompted to enter a new
122
-
release tag. To assist with this, the script displays the tag retrieved in
123
-
the previous step, and validates the format of the inputted tag (vX.X.X). The
124
-
user is also reminded to update the version field in package.json.
125
-
1. **Tagging the new release:** The script then tags a new release and syncs the
126
-
separate major tag (e.g. v1, v2) with the new release tag (e.g. v1.0.0,
127
-
v2.1.2). When the user is creating a new major release, the script
128
-
auto-detects this and creates a `releases/v#` branch for the previous major
129
-
version.
130
-
1. **Pushing changes to remote:** Finally, the script pushes the necessary
131
-
commits, tags and branches to the remote repository. From here, you will need
132
-
to create a new release in GitHub so users can easily reference the new tags
133
-
in their workflows.
108
+
Once the PR is approved and __merged into the release branch__, a project maintainer can start the release process by:
109
+
110
+
1. Checking the version number in the `package.json` file and updating it if necessary.
111
+
2. Checking the action version in the `.github/actions/check-and-comment/action.yml` file and updating it if necessary.
112
+
3. Updating the CHANGELOG.md file with the changes in the new version.
113
+
4. Remove the beta tags created for the PR check.
114
+
5. Tagging the release branch with the corresponding version numbers.
115
+
116
+
This project includes a helper script, [`script/release`](./script/release)
117
+
designed to streamline the process of tagging and pushing new releases for
118
+
GitHub Actions.
119
+
120
+
GitHub Actions allows users to select a specific version of the action to use,
121
+
based on release tags. This script simplifies this process by performing the
122
+
following steps:
123
+
124
+
1. **Retrieving the latest release tag:** The script starts by fetching the most
125
+
recent SemVer release tag of the current branch, by looking at the local data
126
+
available in your repository.
127
+
2. **Prompting for a new release tag:** The user is then prompted to enter a new
128
+
release tag. To assist with this, the script displays the tag retrieved in
129
+
the previous step, and validates the format of the inputted tag (vX.X.X). The
130
+
user is also reminded to update the version field in package.json.
131
+
3. **Tagging the new release:** The script then tags a new release and syncs the
132
+
separate major tag (e.g. v1, v2) with the new release tag (e.g. v1.0.0,
133
+
v2.1.2). When the user is creating a new major release, the script
134
+
auto-detects this and creates a `releases/v#` branch for the previous major
135
+
version.
136
+
4. **Pushing changes to remote:** Finally, the script pushes the necessary
137
+
commits, tags and branches to the remote repository. From here, you will need
138
+
to create a new release in GitHub so users can easily reference the new tags
139
+
in their workflows.
140
+
6. Create a new release in GitHub with the tag created in the previous step and the changes in the CHANGELOG.md file.
0 commit comments