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
{{ message }}
This repository was archived by the owner on Mar 31, 2026. It is now read-only.
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+13-13Lines changed: 13 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ git checkout main
7
7
git pull
8
8
```
9
9
10
-
2. Run the script that will generate the CHANGELOG for you:
10
+
2. Run the script that will generate the CHANGELOG for you:
11
11
12
12
```bash
13
13
sh tool/release_ready.sh <new-version>
@@ -19,26 +19,27 @@ sh tool/release_ready.sh <new-version>
19
19
20
20
The release_ready script will:
21
21
22
-
- Create a new branch just for this release and checkout to it.
23
-
- Automatically update the CHANGELOG file with the associated changes.
22
+
- Create a new branch just for this release and checkout to it.
23
+
- Automatically update the CHANGELOG file with the associated changes.
24
24
25
-
3. Manually remove the *(deps-dev)* scope or other entries of the conventional commits entries in the CHANGELOG
26
-
4. Add the changes and commit with the commit message that the *release_ready* script outputted.
27
-
5. Raise a Pull Request, the title should be the same as the commit message outputted by the *release_ready* script.
25
+
3. Manually remove the _(deps-dev)_ scope or other entries of the conventional commits entries in the CHANGELOG
26
+
4. Add the changes and commit with the commit message that the _release_ready_ script outputted.
27
+
5. Raise a Pull Request, the title should be the same as the commit message outputted by the _release_ready_ script.
28
28
6. When the Pull Request is merged, tag a new release to the commit. When adding the tag ensure:
29
-
- The tag is pointing to the commit that you recently merged.
30
-
- The title of the tag should be v<new-version>
31
-
- The title of the release should be v<new-version>
32
-
- The description should be a raw copy of the CHANGELOG’s file version’s body you recently crafted (without the version header). If in doubt, see the other released tags as an example.
29
+
- The tag is pointing to the commit that you recently merged.
30
+
- The title of the tag should be v<new-version>
31
+
- The title of the release should be v<new-version>
32
+
- The description should be a raw copy of the CHANGELOG’s file version’s body you recently crafted (without the version header). If in doubt, see the other released tags as an example.
33
33
7. After the release is tagged the new changes will be available by the the following syntax:
34
34
35
35
```yaml
36
36
VeryGoodOpenSource/..@v<new-version>
37
37
```
38
38
39
-
Where:
39
+
Where:
40
40
41
41
-`<new-version>`: The version of this new workflow or action, for example: 0.2.1
42
+
42
43
8. Go to the **main** branch and ensure it is up to date with the remote:
43
44
44
45
```yaml
@@ -54,12 +55,11 @@ For the Workflow or Action to be updated for those users using the `@<major-vers
54
55
sh tool/retag_v<major-version>.sh <new-version>
55
56
```
56
57
57
-
Where:
58
+
Where:
58
59
59
60
-`<major-version>`: Is the major version of the release, for example in 2.16.3 the major version is 2. For more information see the [semantic versioning documentation](https://semver.org/).
60
61
-`<new-version>`: The version of this new workflow or action, for example: 0.2.1.
61
62
62
-
63
63
If your change is a breaking change and requires a new major release you should update the name of the retag script and its `v<major-version>` instances.
64
64
65
65
10. After the retag the new changes will be available by the the following syntax:
0 commit comments