Skip to content

Commit 4443078

Browse files
committed
add task to generate changelog and describe the usage in the contribution guide
1 parent 8367acc commit 4443078

File tree

5 files changed

+11
-2
lines changed

5 files changed

+11
-2
lines changed

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
/actionlint.exe
33
/.testtimestamp
44
/.linttimestamp
5+
/.bumptimestamp
56
/env.sh
67
/.github/actionlint.yaml
78
/.github/actionlint.yml

CHANGELOG.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
- Disallow the usage of popular actions that run on `node16` runner. The `node16` runner [will reach the end of life on November 12](https://github.blog/changelog/2024-09-25-end-of-life-for-actions-node16/).
55
- In case of the error, please update your actions to the latest version so that they run on the latest `node20` runner.
66
- If you're using self-hosted runner and you cannot upgrade your runner to `node20` soon, please consider to ignore the error by the `paths` configuration described below.
7+
- If you're using `actions/upload-artifact@v3` and `actions/download-artifact@v3` on GHES, please replace them with `actions/upload-artifact@v3-node20` and `actions/download-artifact@v3-node20`. ([#468](https://github.com/rhysd/actionlint/issues/468))
78
- Provide the configuration for ignoring errors by regular expressions in `actionlint.yml` (or `actionlint.yaml`). Please see the [document](https://github.com/rhysd/actionlint/blob/v1.7.4/docs/config.md) for more details. ([#217](https://github.com/rhysd/actionlint/issues/217), [#342](https://github.com/rhysd/actionlint/issues/342))
89
- The `paths` is a mapping from the file path glob pattern to the corresponding configuration. The `ignore` configuration is a list of regular expressions to match error messages (similar to the `-ignore` command line option).
910
```yaml
@@ -14,7 +15,7 @@
1415
# Ignore the specific error from shellcheck
1516
- 'shellcheck reported issue in this script: SC2086:.+'
1617
# This pattern only matches '.github/workflows/release.yaml' file.
17-
.github/workflows/self-hosted.yaml:
18+
.github/workflows/release.yaml:
1819
ignore:
1920
# Ignore errors from the old runner check. This may be useful for (outdated) self-hosted runner environment.
2021
- 'the runner of ".+" action is too old to run on GitHub Actions'

CONTRIBUTING.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -115,7 +115,8 @@ When releasing v1.2.3 as example:
115115
- The CI job also updates version string in `./scripts/download-actionlint.bash`
116116
4. Open the pre-release at [release page](https://github.com/rhysd/actionlint/releases) with browser
117117
5. Write up release notes, uncheck pre-release checkbox and publish the new release
118-
6. Run `changelog-from-release > CHANGELOG.md` locally to update [CHANGELOG.md](./CHANGELOG.md) and make a commit for the change
118+
6. Run `make CHANGELOG.md` to update [CHANGELOG.md](./CHANGELOG.md) and make a commit for the change. This step requires
119+
[changelog-from-release](https://github.com/rhysd/changelog-from-release) installed on your local.
119120
7. Run `git pull` to merge upstream changes to local `main` branch and run `git push origin main`
120121
8. Update the playground by `./playground/deploy.bash` if it is not updated yet for the release
121122

Makefile

+3
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,9 @@ scripts/generate-actionlint-matcher/test/no_escape.txt: actionlint
6868
scripts/generate-actionlint-matcher/test/want.json: actionlint
6969
./actionlint -format '{{json .}}' ./testdata/err/one_error.yaml > scripts/generate-actionlint-matcher/test/want.json || true
7070

71+
CHANGELOG.md: .bumptimestamp
72+
changelog-from-release > CHANGELOG.md
73+
7174
c clean:
7275
rm -f ./actionlint ./.testtimestamp ./.linttimestamp ./actionlint_fuzz-fuzz.zip ./man/actionlint.1 ./man/actionlint.1.html ./actionlint-workflow-ast
7376
rm -rf ./corpus ./crashers

scripts/bump-version.bash

+3
Original file line numberDiff line numberDiff line change
@@ -88,4 +88,7 @@ if [[ "$OSTYPE" == darwin* ]]; then
8888
open "$job_url"
8989
fi
9090

91+
echo "Update version bump timestamp"
92+
touch .bumptimestamp
93+
9194
echo 'Done.'

0 commit comments

Comments
 (0)