Skip to content
This repository was archived by the owner on Mar 31, 2026. It is now read-only.

Commit d85dc1a

Browse files
committed
refactor: migrate to ES modules
1 parent 87159ba commit d85dc1a

12 files changed

Lines changed: 31230 additions & 3232 deletions

.github/ISSUE_TEMPLATE/config.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
blank_issues_enabled: false
1+
blank_issues_enabled: false

CONTRIBUTING.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ git checkout main
77
git pull
88
```
99

10-
2. Run the script that will generate the CHANGELOG for you:
10+
2. Run the script that will generate the CHANGELOG for you:
1111

1212
```bash
1313
sh tool/release_ready.sh <new-version>
@@ -19,26 +19,27 @@ sh tool/release_ready.sh <new-version>
1919

2020
The release_ready script will:
2121

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.
2424

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.
2828
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.
3333
7. After the release is tagged the new changes will be available by the the following syntax:
3434

3535
```yaml
3636
VeryGoodOpenSource/..@v<new-version>
3737
```
3838

39-
Where:
39+
Where:
4040

4141
- `<new-version>`: The version of this new workflow or action, for example: 0.2.1
42+
4243
8. Go to the **main** branch and ensure it is up to date with the remote:
4344

4445
```yaml
@@ -54,12 +55,11 @@ For the Workflow or Action to be updated for those users using the `@<major-vers
5455
sh tool/retag_v<major-version>.sh <new-version>
5556
```
5657

57-
Where:
58+
Where:
5859

5960
- `<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/).
6061
- `<new-version>`: The version of this new workflow or action, for example: 0.2.1.
6162

62-
6363
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.
6464

6565
10. After the retag the new changes will be available by the the following syntax:

0 commit comments

Comments
 (0)