From 8df808b12cd3bf9acc525763091cca6283341bce Mon Sep 17 00:00:00 2001 From: Thanh Nguyen Date: Tue, 8 Aug 2023 23:40:06 +1000 Subject: [PATCH] update docs --- .github/workflows/release.yaml | 2 +- README.md | 6 +++++- RELEASE-NOTES.md | 4 ++++ 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 562ec38..17c5989 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -19,7 +19,7 @@ jobs: - name: Checkout Code uses: actions/checkout@v3 - name: SemRelease - uses: ./ + uses: btnguyen2k/action-semrelease@v1 with: github-token: ${{ secrets.GITHUB_TOKEN }} tag-major-release: true diff --git a/README.md b/README.md index c39be22..8413c22 100644 --- a/README.md +++ b/README.md @@ -32,7 +32,11 @@ This action reads release information from a release notes file located in the r 👉 The version string must follow [Semantic Versioning spec](https://semver.org), and can be optionally prefixed by letter `v`. -👉 Name of the release notes file must be one of the following `RELEASE-NOTES.md`, `RELEASE_NOTES.MD`, `RELEASE-NOTES`, `RELEASE_NOTES.md`, `RELEASE_NOTES.MD`, `RELEASE_NOTES`, `release-notes.md`, `release-notes`, `release_notes.md` and `release_notes`. +👉 Name of the release notes file must be one of the following `RELEASE-NOTES.md`, `RELEASE_NOTES.MD`, `RELEASE-NOTES`, +`RELEASE_NOTES.md`, `RELEASE_NOTES.MD`, `RELEASE_NOTES`, `release-notes.md`, `release-notes`, `release_notes.md`, +`release_notes`, `CHANGELOG.md`, `CHANGELOG.MD`, `CHANGELOG`, `CHANGE-LOG.md`, `CHANGE-LOG.MD`, `CHANGE-LOG`, +`CHANGE_LOG.md`, `CHANGE_LOG.MD`, `CHANGE_LOG`, `changelog.md`, `changelog`, `change-log.md`, `change-log`, +`change_log.md`, `change_log`. ## Inputs diff --git a/RELEASE-NOTES.md b/RELEASE-NOTES.md index 8bc96ee..8134698 100644 --- a/RELEASE-NOTES.md +++ b/RELEASE-NOTES.md @@ -1,5 +1,9 @@ # SemRelease release notes +## 2023-08-08 - v1.1.1 + +- Fix: missing doc. + ## 2023-08-08 - v1.1.0 - Add input `tag-prefix`.