diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml index 4fdabc0..5073ce3 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yaml +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -70,6 +70,11 @@ body: attributes: label: Relevant log output description: Please copy and paste any relevant log output. This will be automatically formatted into code, so no need for backticks. + placeholder: | + This can be achieved by: + 1. Re-running the workflow with debug logging enabled. + 2. Copy or download the log archive. + 3. Paste the contents here or upload the file in a subsequent comment. render: shell - type: textarea attributes: diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml index 9ee6d34..9f930cc 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yaml +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -53,7 +53,7 @@ body: id: terms attributes: label: Code of Conduct - description: By submitting this issue, you agree to follow our [Code of Conduct](./CODE_OF_CONDUCT.md) + description: By submitting this issue, you agree to follow our [Code of Conduct](../blob/main/CODE_OF_CONDUCT.md) options: - label: I agree to follow this project's Code of Conduct required: true diff --git a/.github/dependabot.yml b/.github/dependabot.yml index f0527e6..6a007d1 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -5,6 +5,11 @@ updates: schedule: interval: daily open-pull-requests-limit: 10 +- package-ecosystem: docker + directory: "/" + schedule: + interval: daily + open-pull-requests-limit: 10 - package-ecosystem: github-actions directory: "/" schedule: diff --git a/.github/workflows/auto-approve.yml b/.github/workflows/auto-approve.yml index d537315..0de2e3d 100644 --- a/.github/workflows/auto-approve.yml +++ b/.github/workflows/auto-approve.yml @@ -7,7 +7,7 @@ jobs: auto-approve: runs-on: ubuntu-latest steps: - - uses: hmarr/auto-approve-action@v2 + - uses: hmarr/auto-approve-action@v3 if: | ( github.event.pull_request.user.login == 'dependabot[bot]' || diff --git a/.github/workflows/auto-merge.yml b/.github/workflows/auto-merge.yml index 0af8f49..43086ff 100644 --- a/.github/workflows/auto-merge.yml +++ b/.github/workflows/auto-merge.yml @@ -16,7 +16,7 @@ jobs: github.actor == 'renovate' steps: - name: automerge - uses: pascalgn/automerge-action@v0.15.3 + uses: pascalgn/automerge-action@v0.15.5 env: GITHUB_TOKEN: ${{ secrets.PAT_TOKEN }} MERGE_METHOD: "rebase" diff --git a/.github/workflows/codacy-analysis.yml b/.github/workflows/codacy-analysis.yml index 4b5086e..e315344 100644 --- a/.github/workflows/codacy-analysis.yml +++ b/.github/workflows/codacy-analysis.yml @@ -19,6 +19,11 @@ on: jobs: codacy-security-scan: + # Cancel other workflows that are running for the same branch + # https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions#concurrency + concurrency: + group: ${{ github.workflow }}-${{ github.ref }} + cancel-in-progress: true name: Codacy Security Scan runs-on: ubuntu-latest steps: @@ -28,7 +33,8 @@ jobs: # Execute Codacy Analysis CLI and generate a SARIF output with the security issues identified during the analysis - name: Run Codacy Analysis CLI - uses: codacy/codacy-analysis-cli-action@v4.1.0 + continue-on-error: true + uses: codacy/codacy-analysis-cli-action@v4.2.0 with: # Check https://github.com/codacy/codacy-analysis-cli#project-token to get your project token from your Codacy repository # You can also omit the token and run the tools that support default configurations @@ -39,11 +45,12 @@ jobs: # Adjust severity of non-security issues gh-code-scanning-compat: true # Force 0 exit code to allow SARIF file generation - # This will handover control about PR rejection to the GitHub side + # This will hand over control about PR rejection to the GitHub side max-allowed-issues: 2147483647 # Upload the SARIF file generated in the previous step - name: Upload SARIF results file + continue-on-error: true uses: github/codeql-action/upload-sarif@v2 with: sarif_file: results.sarif diff --git a/.github/workflows/ghcr.yml b/.github/workflows/ghcr.yml index e55abe9..cea65d5 100644 --- a/.github/workflows/ghcr.yml +++ b/.github/workflows/ghcr.yml @@ -10,7 +10,7 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v3.0.2 + uses: actions/checkout@v3.2.0 - name: Get branch names id: branch-name @@ -19,20 +19,20 @@ jobs: strip_tag_prefix: 'v' - name: Set up QEMU - uses: docker/setup-qemu-action@v2.0.0 + uses: docker/setup-qemu-action@v2.1.0 - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v2.0.0 + uses: docker/setup-buildx-action@v2.2.1 - name: Login to GitHub Container Registry - uses: docker/login-action@v2.0.0 + uses: docker/login-action@v2.1.0 with: registry: ghcr.io username: ${{ github.repository_owner }} password: ${{ secrets.GITHUB_TOKEN }} - name: Build and push - uses: docker/build-push-action@v3.1.1 + uses: docker/build-push-action@v3.2.0 with: context: . push: true diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml index b52ba26..d3ebb71 100644 --- a/.github/workflows/greetings.yml +++ b/.github/workflows/greetings.yml @@ -6,8 +6,8 @@ jobs: greeting: runs-on: ubuntu-latest steps: - - uses: actions/first-interaction@v1.1.0 - with: - repo-token: ${{ secrets.GITHUB_TOKEN }} - issue-message: "Thanks for reporting this issue, don't forget to star this project to help us reach a wider audience." - pr-message: "Thanks for implementing a fix, could you ensure that the test covers your changes." + - uses: actions/first-interaction@v1 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + issue-message: "Thanks for reporting this issue, don't forget to star this project if you haven't already to help us reach a wider audience." + pr-message: "Thanks for implementing a fix, could you ensure that the test covers your changes if applicable." diff --git a/.github/workflows/rebase.yml b/.github/workflows/rebase.yml index 5fca228..68dcf57 100644 --- a/.github/workflows/rebase.yml +++ b/.github/workflows/rebase.yml @@ -8,11 +8,11 @@ jobs: if: github.event.issue.pull_request != '' && contains(github.event.comment.body, '/rebase') runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3.0.2 + - uses: actions/checkout@v3.2.0 with: token: ${{ secrets.PAT_TOKEN }} fetch-depth: 0 # otherwise, you will failed to push refs to dest repo - name: Automatic Rebase - uses: cirrus-actions/rebase@1.7 + uses: cirrus-actions/rebase@1.8 env: GITHUB_TOKEN: ${{ secrets.PAT_TOKEN }} diff --git a/.github/workflows/sync-release-version.yml b/.github/workflows/sync-release-version.yml index 3b66049..dbba515 100644 --- a/.github/workflows/sync-release-version.yml +++ b/.github/workflows/sync-release-version.yml @@ -8,24 +8,28 @@ jobs: update-version: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3.0.2 + - uses: actions/checkout@v3 with: fetch-depth: 0 + - name: Run release-tagger + uses: tj-actions/release-tagger@v2 - name: Sync release version. - uses: tj-actions/sync-release-version@v11 + uses: tj-actions/sync-release-version@v13 id: sync-release-version with: pattern: '${{ github.repository }}@' + only_major: true paths: | README.md - name: Generate CHANGELOG - uses: tj-actions/github-changelog-generator@v1.14 + uses: tj-actions/github-changelog-generator@v1.16 with: output: 'HISTORY.md' - name: Create Pull Request - uses: peter-evans/create-pull-request@v4.1.1 + uses: peter-evans/create-pull-request@v4.2.3 with: base: "main" + labels: "merge when passing" title: "Upgraded to ${{ steps.sync-release-version.outputs.new_version }}" branch: "upgrade-to-${{ steps.sync-release-version.outputs.new_version }}" commit-message: "Upgraded from ${{ steps.sync-release-version.outputs.old_version }} -> ${{ steps.sync-release-version.outputs.new_version }}" diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 0c6d061..799c700 100644 --- a/.github/workflows/test.yml +++ b/.github/workflows/test.yml @@ -14,9 +14,9 @@ jobs: name: Test github-changelog-generator steps: - name: Checkout - uses: actions/checkout@v3.0.2 + uses: actions/checkout@v3.2.0 - name: shellcheck - uses: reviewdog/action-shellcheck@v1.15 + uses: reviewdog/action-shellcheck@v1.16 - name: Run github-changelog-generator uses: ./ with: diff --git a/.github/workflows/update-readme.yml b/.github/workflows/update-readme.yml index 9da5e35..335f4a3 100644 --- a/.github/workflows/update-readme.yml +++ b/.github/workflows/update-readme.yml @@ -9,15 +9,18 @@ jobs: sync-assets: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v3.0.2 + - uses: actions/checkout@v3.2.0 with: fetch-depth: 0 + + - name: Run auto-doc + uses: tj-actions/auto-doc@v1.6.0 - name: Run test uses: tj-actions/remark@v3 - name: Verify Changed files - uses: tj-actions/verify-changed-files@v11 + uses: tj-actions/verify-changed-files@v13 id: verify_changed_files with: files: | diff --git a/Dockerfile b/Dockerfile index 880fff7..09316f3 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,4 +1,4 @@ -FROM ruby:3.0.3-alpine3.13 +FROM ruby:3.2.0-alpine3.17 LABEL maintainer="Tonye Jack " @@ -9,7 +9,7 @@ COPY Gemfile* ./ RUN apk add --no-cache \ --virtual .gem-installdeps \ build-base \ - && gem install bundler --version 2.3.9 \ + && gem install bundler --version 2.4.1 \ && bundle config set --local system 'true' \ && bundle install \ && gem uninstall bundler \ diff --git a/Gemfile.lock b/Gemfile.lock index 3ce0a14..33d8d55 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -1,41 +1,41 @@ GEM remote: https://rubygems.org/ specs: - activesupport (7.0.3.1) + activesupport (7.0.4) concurrent-ruby (~> 1.0, >= 1.0.2) i18n (>= 1.6, < 2) minitest (>= 5.1) tzinfo (~> 2.0) addressable (2.8.1) public_suffix (>= 2.0.2, < 6.0) - async (1.30.3) + async (2.3.1) console (~> 1.10) - nio4r (~> 2.3) + io-event (~> 1.1) timers (~> 4.1) - async-http (0.59.2) + async-http (0.59.4) async (>= 1.25) async-io (>= 1.28) async-pool (>= 0.2) protocol-http (~> 0.23.1) protocol-http1 (~> 0.14.0) protocol-http2 (~> 0.14.0) - traces (>= 0.4.0) + traces (>= 0.8.0) async-http-faraday (0.11.0) async-http (~> 0.42) faraday - async-io (1.34.0) + async-io (1.34.1) async async-pool (0.3.12) async (>= 1.25) concurrent-ruby (1.1.10) - console (1.15.3) + console (1.16.2) fiber-local - faraday (2.5.2) + faraday (2.7.2) faraday-net_http (>= 2.0, < 3.1) ruby2_keywords (>= 0.0.4) faraday-http-cache (2.4.1) faraday (>= 0.8) - faraday-net_http (3.0.0) + faraday-net_http (3.0.2) fiber-local (1.0.0) github_changelog_generator (1.16.4) activesupport @@ -48,9 +48,9 @@ GEM rake (>= 10.0) i18n (1.12.0) concurrent-ruby (~> 1.0) + io-event (1.1.4) minitest (5.16.3) multi_json (1.15.0) - nio4r (2.5.8) octokit (4.25.1) faraday (>= 1, < 3) sawyer (~> 0.9) @@ -61,24 +61,23 @@ GEM protocol-http2 (0.14.2) protocol-hpack (~> 1.4) protocol-http (~> 0.18) - public_suffix (5.0.0) + public_suffix (5.0.1) rainbow (3.1.1) rake (13.0.6) ruby2_keywords (0.0.5) sawyer (0.9.2) addressable (>= 2.3.5) faraday (>= 0.17.3, < 3) - timers (4.3.4) - traces (0.6.1) + timers (4.3.5) + traces (0.8.0) tzinfo (2.0.5) concurrent-ruby (~> 1.0) PLATFORMS - universal-darwin-21 - x86_64-linux + arm64-darwin-21 DEPENDENCIES github_changelog_generator (= 1.16.4)! BUNDLED WITH - 2.3.9 + 2.4.1 diff --git a/HISTORY.md b/HISTORY.md index 01c4eda..6f91068 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,5 +1,76 @@ # Changelog +## [v1](https://github.com/tj-actions/github-changelog-generator/tree/v1) (2022-12-28) + +[Full Changelog](https://github.com/tj-actions/github-changelog-generator/compare/v1.16...v1) + +## [v1.16](https://github.com/tj-actions/github-changelog-generator/tree/v1.16) (2022-12-28) + +[Full Changelog](https://github.com/tj-actions/github-changelog-generator/compare/v1.15...v1.16) + +**Merged pull requests:** + +- chore: update gemlock [\#204](https://github.com/tj-actions/github-changelog-generator/pull/204) ([jackton1](https://github.com/jackton1)) +- chore\(deps\): lock file maintenance [\#203](https://github.com/tj-actions/github-changelog-generator/pull/203) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): lock file maintenance [\#202](https://github.com/tj-actions/github-changelog-generator/pull/202) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update tj-actions/verify-changed-files action to v13 [\#201](https://github.com/tj-actions/github-changelog-generator/pull/201) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update cirrus-actions/rebase action to v1.8 [\#200](https://github.com/tj-actions/github-changelog-generator/pull/200) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update reviewdog/action-shellcheck action to v1.16 [\#199](https://github.com/tj-actions/github-changelog-generator/pull/199) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update actions/checkout action to v3.2.0 [\#198](https://github.com/tj-actions/github-changelog-generator/pull/198) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): lock file maintenance [\#197](https://github.com/tj-actions/github-changelog-generator/pull/197) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update peter-evans/create-pull-request action to v4.2.3 [\#196](https://github.com/tj-actions/github-changelog-generator/pull/196) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update peter-evans/create-pull-request action to v4.2.2 [\#195](https://github.com/tj-actions/github-changelog-generator/pull/195) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update peter-evans/create-pull-request action to v4.2.1 [\#194](https://github.com/tj-actions/github-changelog-generator/pull/194) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): lock file maintenance [\#192](https://github.com/tj-actions/github-changelog-generator/pull/192) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): bump hmarr/auto-approve-action from 2 to 3 [\#191](https://github.com/tj-actions/github-changelog-generator/pull/191) ([dependabot[bot]](https://github.com/apps/dependabot)) +- chore\(deps\): lock file maintenance [\#190](https://github.com/tj-actions/github-changelog-generator/pull/190) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update docker/setup-buildx-action action to v2.2.1 [\#189](https://github.com/tj-actions/github-changelog-generator/pull/189) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update peter-evans/create-pull-request action to v4.2.0 [\#188](https://github.com/tj-actions/github-changelog-generator/pull/188) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update pascalgn/automerge-action action to v0.15.5 [\#187](https://github.com/tj-actions/github-changelog-generator/pull/187) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update docker/setup-buildx-action action to v2.2.0 [\#186](https://github.com/tj-actions/github-changelog-generator/pull/186) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update peter-evans/create-pull-request action to v4.1.4 [\#185](https://github.com/tj-actions/github-changelog-generator/pull/185) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): lock file maintenance [\#184](https://github.com/tj-actions/github-changelog-generator/pull/184) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update tj-actions/verify-changed-files action to v12 [\#183](https://github.com/tj-actions/github-changelog-generator/pull/183) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update docker/setup-qemu-action action to v2.1.0 [\#182](https://github.com/tj-actions/github-changelog-generator/pull/182) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update docker/setup-buildx-action action to v2.1.0 [\#181](https://github.com/tj-actions/github-changelog-generator/pull/181) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update docker/login-action action to v2.1.0 [\#180](https://github.com/tj-actions/github-changelog-generator/pull/180) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update docker/build-push-action action to v3.2.0 [\#179](https://github.com/tj-actions/github-changelog-generator/pull/179) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): lock file maintenance [\#178](https://github.com/tj-actions/github-changelog-generator/pull/178) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update actions/first-interaction action to v1.1.1 [\#177](https://github.com/tj-actions/github-changelog-generator/pull/177) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update actions/checkout action to v3.1.0 [\#176](https://github.com/tj-actions/github-changelog-generator/pull/176) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update peter-evans/create-pull-request action to v4.1.3 [\#175](https://github.com/tj-actions/github-changelog-generator/pull/175) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update peter-evans/create-pull-request action to v4.1.2 [\#174](https://github.com/tj-actions/github-changelog-generator/pull/174) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update codacy/codacy-analysis-cli-action action to v4.2.0 [\#173](https://github.com/tj-actions/github-changelog-generator/pull/173) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update tj-actions/sync-release-version action to v13 [\#172](https://github.com/tj-actions/github-changelog-generator/pull/172) ([renovate[bot]](https://github.com/apps/renovate)) +- Upgraded to v1.15 [\#171](https://github.com/tj-actions/github-changelog-generator/pull/171) ([jackton1](https://github.com/jackton1)) +- chore\(deps\): update tj-actions/github-changelog-generator action to v1.15 [\#170](https://github.com/tj-actions/github-changelog-generator/pull/170) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): lock file maintenance [\#169](https://github.com/tj-actions/github-changelog-generator/pull/169) ([renovate[bot]](https://github.com/apps/renovate)) + +## [v1.15](https://github.com/tj-actions/github-changelog-generator/tree/v1.15) (2022-09-05) + +[Full Changelog](https://github.com/tj-actions/github-changelog-generator/compare/v1.14...v1.15) + +**Merged pull requests:** + +- chore\(deps\): lock file maintenance [\#168](https://github.com/tj-actions/github-changelog-generator/pull/168) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): lock file maintenance [\#167](https://github.com/tj-actions/github-changelog-generator/pull/167) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update tj-actions/branch-names action to v6 [\#166](https://github.com/tj-actions/github-changelog-generator/pull/166) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update tj-actions/verify-changed-files action to v11 [\#165](https://github.com/tj-actions/github-changelog-generator/pull/165) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): lock file maintenance [\#164](https://github.com/tj-actions/github-changelog-generator/pull/164) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update peter-evans/create-pull-request action to v4.1.1 [\#163](https://github.com/tj-actions/github-changelog-generator/pull/163) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update peter-evans/create-pull-request action to v4.1.0 [\#162](https://github.com/tj-actions/github-changelog-generator/pull/162) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): lock file maintenance [\#161](https://github.com/tj-actions/github-changelog-generator/pull/161) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): lock file maintenance [\#160](https://github.com/tj-actions/github-changelog-generator/pull/160) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update docker/build-push-action action to v3.1.1 [\#159](https://github.com/tj-actions/github-changelog-generator/pull/159) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): lock file maintenance [\#158](https://github.com/tj-actions/github-changelog-generator/pull/158) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): lock file maintenance [\#157](https://github.com/tj-actions/github-changelog-generator/pull/157) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update docker/build-push-action action to v3.1.0 [\#156](https://github.com/tj-actions/github-changelog-generator/pull/156) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): lock file maintenance [\#155](https://github.com/tj-actions/github-changelog-generator/pull/155) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): lock file maintenance [\#154](https://github.com/tj-actions/github-changelog-generator/pull/154) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): lock file maintenance [\#153](https://github.com/tj-actions/github-changelog-generator/pull/153) ([renovate[bot]](https://github.com/apps/renovate)) +- chore\(deps\): update tj-actions/github-changelog-generator action to v1.14 [\#152](https://github.com/tj-actions/github-changelog-generator/pull/152) ([renovate[bot]](https://github.com/apps/renovate)) +- Upgraded to v1.14 [\#151](https://github.com/tj-actions/github-changelog-generator/pull/151) ([jackton1](https://github.com/jackton1)) + ## [v1.14](https://github.com/tj-actions/github-changelog-generator/tree/v1.14) (2022-06-27) [Full Changelog](https://github.com/tj-actions/github-changelog-generator/compare/v1.13...v1.14) @@ -239,11 +310,7 @@ ## [v1.1](https://github.com/tj-actions/github-changelog-generator/tree/v1.1) (2021-02-21) -[Full Changelog](https://github.com/tj-actions/github-changelog-generator/compare/v1...v1.1) - -## [v1](https://github.com/tj-actions/github-changelog-generator/tree/v1) (2021-02-21) - -[Full Changelog](https://github.com/tj-actions/github-changelog-generator/compare/ffa35139b8f946ad67197790e00444a93424428f...v1) +[Full Changelog](https://github.com/tj-actions/github-changelog-generator/compare/ffa35139b8f946ad67197790e00444a93424428f...v1.1) diff --git a/README.md b/README.md index c8c4783..04c80da 100644 --- a/README.md +++ b/README.md @@ -12,17 +12,21 @@ Generate CHANGELOG/HISTORY markdown files for your project steps: - uses: actions/checkout@v2 - name: Generate CHANGELOG - uses: tj-actions/github-changelog-generator@v1.14 + uses: tj-actions/github-changelog-generator@v1.15 with: output: 'HISTORY.md' ``` ## Inputs -| Input | type | required | default | description | -|:-------------:|:-----------:|:-------------:|:----------------------------:|:-------------:| -| token | `string` | `true` | `${{ github.token }}` | [GITHUB\_TOKEN](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow)
or a repo scoped
[Personal Access Token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) | -| output | `string` | `false` | `CHANGELOG.md` | The Changelog output file. | + + +| INPUT | TYPE | REQUIRED | DEFAULT | DESCRIPTION | +|--------|--------|----------|-------------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------| +| output | string | false | `"CHANGELOG.md"` | The changelog output file | +| token | string | true | `"${{ github.token }}"` | The default [GITHUB\_TOKEN](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow) or a repo scoped
[Personal Access Token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) | + + * Free software: [MIT license](LICENSE) diff --git a/action.yml b/action.yml index 7e642a1..8d3765a 100644 --- a/action.yml +++ b/action.yml @@ -3,21 +3,18 @@ description: Github Changelog/History Generator author: tj-actions inputs: token: - description: 'GITHUB_TOKEN or a Repo scoped PAT' + description: 'The default [GITHUB_TOKEN](https://docs.github.com/en/free-pro-team@latest/actions/reference/authentication-in-a-workflow#using-the-github_token-in-a-workflow) or a repo scoped [Personal Access Token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token)' required: true default: ${{ github.token }} output: - description: 'Output file' + description: 'The changelog output file' required: false default: "CHANGELOG.md" runs: using: 'docker' - image: 'Dockerfile' + image: 'docker://ghcr.io/tj-actions/github-changelog-generator:latest' entrypoint: '/entrypoint.sh' - args: - - ${{ inputs.token }} - - ${{ inputs.output }} branding: icon: file-text color: white