diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index 5d3171a..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,32 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: "[BUG]" -labels: bug -assignees: '' - ---- - -**Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information):** - - OS: [e.g. iOS] - - Browser [e.g. chrome, safari] - - Version [e.g. 22] - -**Additional context** -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml new file mode 100644 index 0000000..4fdabc0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yaml @@ -0,0 +1,92 @@ +name: 🐞 Bug +description: Create a report to help us improve +title: "[BUG] " +labels: [bug, needs triage] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this bug report! + - type: checkboxes + attributes: + label: Is there an existing issue for this? + description: Please search to see if an issue already exists for the bug you encountered. + options: + - label: I have searched the existing issues + required: true + - type: checkboxes + attributes: + label: Does this issue exist in the latest version? + description: Please view all releases to confirm that this issue hasn't already been fixed. + options: + - label: I'm using the latest release + required: true + - type: textarea + id: what-happened + attributes: + label: Describe the bug? + description: A clear and concise description of what the bug is + placeholder: Tell us what you see! + validations: + required: true + - type: textarea + id: reproduce + attributes: + label: To Reproduce + description: Steps to reproduce the behavior? + placeholder: | + 1. In this environment... + 2. With this config... + 3. Run '...' + 4. See error... + validations: + required: true + - type: dropdown + id: os + attributes: + label: What OS are you seeing the problem on? + multiple: true + options: + - all + - ubuntu-latest or ubuntu-20.04 + - ubuntu-18.04 + - macos-latest or macos-10.15 + - macos-11 + - windows-latest or windows-2019 + - windows-2016 + validations: + required: true + - type: textarea + id: expected + attributes: + label: Expected behavior? + description: A clear and concise description of what you expected to happen. + placeholder: Tell us what you expected! + validations: + required: true + - type: textarea + id: logs + 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. + render: shell + - type: textarea + attributes: + label: Anything else? + description: | + Links? or References? + + Anything that will give us more context about the issue you are encountering! + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + 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/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 24473de..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,20 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: '' -assignees: '' - ---- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. - -**Additional context** -Add any other context or screenshots about the feature request here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml new file mode 100644 index 0000000..9ee6d34 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yaml @@ -0,0 +1,59 @@ +name: Feature request +description: Suggest an idea for this project +title: "[Feature] <title>" +labels: [enhancement] + +body: + - type: markdown + attributes: + value: | + Thanks for taking the time to fill out this feature request! + - type: checkboxes + attributes: + label: Is this feature missing in the latest version? + description: Please upgrade to the latest version to verify that this feature is still missing. + options: + - label: I'm using the latest release + required: true + - type: textarea + id: what-happened + attributes: + label: Is your feature request related to a problem? Please describe. + description: | + A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + placeholder: Tell us what you see! + validations: + required: true + - type: textarea + id: requests + attributes: + label: Describe the solution you'd like? + description: A clear and concise description of what you want to happen. + validations: + required: true + - type: textarea + id: alternative + attributes: + label: Describe alternatives you've considered? + description: A clear and concise description of any alternative solutions or features you've considered. + validations: + required: false + - type: textarea + attributes: + label: Anything else? + description: | + Links? or References? + + Add any other context or screenshots about the feature request here. + + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false + - type: checkboxes + id: terms + attributes: + label: Code of Conduct + description: By submitting this issue, you agree to follow our [Code of Conduct](./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 29775d9..f0527e6 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -5,10 +5,6 @@ updates: schedule: interval: daily open-pull-requests-limit: 10 - ignore: - - dependency-name: github_changelog_generator - versions: - - 1.16.1 - package-ecosystem: github-actions directory: "/" schedule: diff --git a/.github/workflows/auto-approve.yml b/.github/workflows/auto-approve.yml index 6315795..d537315 100644 --- a/.github/workflows/auto-approve.yml +++ b/.github/workflows/auto-approve.yml @@ -7,17 +7,26 @@ jobs: auto-approve: runs-on: ubuntu-latest steps: - - uses: hmarr/auto-approve-action@v2 - if: | - github.actor == 'dependabot[bot]' || - github.actor == 'dependabot' || - github.actor == 'dependabot-preview[bot]' || - github.actor == 'dependabot-preview' || - github.actor == 'renovate[bot]' || - github.actor == 'renovate' || - github.actor == 'pyup-bot' || - github.actor == 'github-actions[bot]' || - github.actor == 'pre-commit-ci' || - github.actor == 'pre-commit-ci[bot]' - with: - github-token: ${{ secrets.PAT_TOKEN }} + - uses: hmarr/auto-approve-action@v2 + if: | + ( + github.event.pull_request.user.login == 'dependabot[bot]' || + github.event.pull_request.user.login == 'dependabot' || + github.event.pull_request.user.login == 'dependabot-preview[bot]' || + github.event.pull_request.user.login == 'dependabot-preview' || + github.event.pull_request.user.login == 'renovate[bot]' || + github.event.pull_request.user.login == 'renovate' || + github.event.pull_request.user.login == 'github-actions[bot]' + ) + && + ( + github.actor == 'dependabot[bot]' || + github.actor == 'dependabot' || + github.actor == 'dependabot-preview[bot]' || + github.actor == 'dependabot-preview' || + github.actor == 'renovate[bot]' || + github.actor == 'renovate' || + github.actor == 'github-actions[bot]' + ) + with: + github-token: ${{ secrets.PAT_TOKEN }} diff --git a/.github/workflows/auto-merge.yml b/.github/workflows/auto-merge.yml new file mode 100644 index 0000000..065d116 --- /dev/null +++ b/.github/workflows/auto-merge.yml @@ -0,0 +1,26 @@ +name: automerge +on: + check_suite: + types: + - completed + +jobs: + automerge: + runs-on: ubuntu-latest + if: | + github.actor == 'dependabot[bot]' || + github.actor == 'dependabot' || + github.actor == 'dependabot-preview[bot]' || + github.actor == 'dependabot-preview' || + github.actor == 'renovate[bot]' || + github.actor == 'renovate' + steps: + - name: automerge + uses: pascalgn/automerge-action@v0.14.3 + env: + GITHUB_TOKEN: ${{ secrets.PAT_TOKEN }} + MERGE_METHOD: "rebase" + UPDATE_METHOD: "rebase" + MERGE_RETRIES: "6" + MERGE_RETRY_SLEEP: "100000" + MERGE_LABELS: "" \ No newline at end of file diff --git a/.github/workflows/codacy-analysis.yml b/.github/workflows/codacy-analysis.yml new file mode 100644 index 0000000..f10cd57 --- /dev/null +++ b/.github/workflows/codacy-analysis.yml @@ -0,0 +1,49 @@ +# This workflow checks out code, performs a Codacy security scan +# and integrates the results with the +# GitHub Advanced Security code scanning feature. For more information on +# the Codacy security scan action usage and parameters, see +# https://github.com/codacy/codacy-analysis-cli-action. +# For more information on Codacy Analysis CLI in general, see +# https://github.com/codacy/codacy-analysis-cli. + +name: Codacy Security Scan + +on: + push: + branches: [ main ] + pull_request: + # The branches below must be a subset of the branches above + branches: [ main ] + schedule: + - cron: '15 16 * * 2' + +jobs: + codacy-security-scan: + name: Codacy Security Scan + runs-on: ubuntu-latest + steps: + # Checkout the repository to the GitHub Actions runner + - name: Checkout code + uses: actions/checkout@v3 + + # 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@4.0.2 + 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 + project-token: ${{ secrets.CODACY_PROJECT_TOKEN }} + verbose: true + output: results.sarif + format: sarif + # 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 + max-allowed-issues: 2147483647 + + # Upload the SARIF file generated in the previous step + - name: Upload SARIF results file + uses: github/codeql-action/upload-sarif@v1 + with: + sarif_file: results.sarif diff --git a/.github/workflows/ghcr.yml b/.github/workflows/ghcr.yml index 5703be9..26b1e23 100644 --- a/.github/workflows/ghcr.yml +++ b/.github/workflows/ghcr.yml @@ -10,29 +10,29 @@ jobs: runs-on: ubuntu-latest steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@v3.0.0 - name: Get branch names id: branch-name - uses: tj-actions/branch-names@v4 + uses: tj-actions/branch-names@v5 with: strip_tag_prefix: 'v' - name: Set up QEMU - uses: docker/setup-qemu-action@v1 + uses: docker/setup-qemu-action@v1.2.0 - name: Set up Docker Buildx - uses: docker/setup-buildx-action@v1 + uses: docker/setup-buildx-action@v1.6.0 - name: Login to GitHub Container Registry - uses: docker/login-action@v1 + uses: docker/login-action@v1.14.1 with: registry: ghcr.io username: ${{ github.repository_owner }} password: ${{ secrets.GITHUB_TOKEN }} - name: Build and push - uses: docker/build-push-action@v2 + uses: docker/build-push-action@v2.9.0 with: context: . push: true diff --git a/.github/workflows/greetings.yml b/.github/workflows/greetings.yml new file mode 100644 index 0000000..b52ba26 --- /dev/null +++ b/.github/workflows/greetings.yml @@ -0,0 +1,13 @@ +name: Greetings + +on: [pull_request_target, issues] + +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." diff --git a/.github/workflows/rebase.yml b/.github/workflows/rebase.yml index 4dbe62a..602aff3 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@v2 + - uses: actions/checkout@v3.0.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.4 + uses: cirrus-actions/rebase@1.5 env: GITHUB_TOKEN: ${{ secrets.PAT_TOKEN }} diff --git a/.github/workflows/sync-release-version.yml b/.github/workflows/sync-release-version.yml index cede5ef..d8b7a06 100644 --- a/.github/workflows/sync-release-version.yml +++ b/.github/workflows/sync-release-version.yml @@ -8,22 +8,22 @@ jobs: update-version: runs-on: ubuntu-latest steps: - - uses: actions/checkout@v2 + - uses: actions/checkout@v3.0.0 with: fetch-depth: 0 - name: Sync release version. - uses: tj-actions/sync-release-version@v8.5 + uses: tj-actions/sync-release-version@v11 id: sync-release-version with: pattern: '${{ github.repository }}@' paths: | README.md - name: Generate CHANGELOG - uses: tj-actions/github-changelog-generator@v1.6 + uses: tj-actions/github-changelog-generator@v1.12 with: output: 'HISTORY.md' - name: Create Pull Request - uses: peter-evans/create-pull-request@v3 + uses: peter-evans/create-pull-request@v3.14.0 with: base: "main" title: "Upgraded to ${{ steps.sync-release-version.outputs.new_version }}" diff --git a/.github/workflows/test.yml b/.github/workflows/test.yml index 49c973d..f25a63e 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@v2 + uses: actions/checkout@v3.0.0 - name: shellcheck - uses: reviewdog/action-shellcheck@v1.5 + uses: reviewdog/action-shellcheck@v1.14 - name: Run github-changelog-generator uses: ./ with: diff --git a/.github/workflows/update-readme.yml b/.github/workflows/update-readme.yml new file mode 100644 index 0000000..ba9aef3 --- /dev/null +++ b/.github/workflows/update-readme.yml @@ -0,0 +1,39 @@ +name: Format README.md + +on: + push: + branches: + - main + +jobs: + sync-assets: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3.0.0 + with: + fetch-depth: 0 + + - name: Run test + uses: tj-actions/remark@v2.3 + + - name: Verify Changed files + uses: tj-actions/verify-changed-files@v9 + id: verify_changed_files + with: + files: | + README.md + - name: README.md changed + if: steps.verify_changed_files.outputs.files_changed == 'true' + run: | + echo "README.md has uncommited changes" + exit 1 + - name: Create Pull Request + if: failure() + uses: peter-evans/create-pull-request@v3 + with: + base: "main" + title: "Updated README.md" + branch: "chore/update-readme" + commit-message: "Updated README.md" + body: "Updated README.md" + token: ${{ secrets.PAT_TOKEN }} diff --git a/.gitignore b/.gitignore index a53c681..cfea8bc 100644 --- a/.gitignore +++ b/.gitignore @@ -1,2 +1,90 @@ -.idea/ -.envrc +### JetBrains template +# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio, WebStorm and Rider +# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839 + +# CMake +cmake-build-*/ + +# Mongo Explorer plugin +.idea/**/mongoSettings.xml + +# File-based project format +*.iws + +# IntelliJ +out/ + +# mpeltonen/sbt-idea plugin +.idea_modules/ + +# JIRA plugin +atlassian-ide-plugin.xml + +# Crashlytics plugin (for Android Studio and IntelliJ) +com_crashlytics_export_strings.xml +crashlytics.properties +crashlytics-build.properties +fabric.properties + +# Android studio 3.1+ serialized cache file +.idea/caches/build_file_checksums.ser + +### Ruby template +*.gem +*.rbc +/.config +/coverage/ +/InstalledFiles +/pkg/ +/spec/reports/ +/spec/examples.txt +/test/tmp/ +/test/version_tmp/ +/tmp/ + +# Used by dotenv library to load environment variables. +# .env + +# Ignore Byebug command history file. +.byebug_history + +## Specific to RubyMotion: +.dat* +.repl_history +build/ +*.bridgesupport +build-iPhoneOS/ +build-iPhoneSimulator/ + +## Specific to RubyMotion (use of CocoaPods): +# +# We recommend against adding the Pods directory to your .gitignore. However +# you should judge for yourself, the pros and cons are mentioned at: +# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control +# +# vendor/Pods/ + +## Documentation cache and generated files: +/.yardoc/ +/_yardoc/ +/doc/ +/rdoc/ + +## Environment normalization: +/.bundle/ +/vendor/bundle +/lib/bundler/man/ + +# for a library or gem, you might want to ignore these files since the code is +# intended to run in multiple environments; otherwise, check them in: +# Gemfile.lock +# .ruby-version +# .ruby-gemset + +# unless supporting rvm < 1.11.0 or doing something fancy, ignore this: +.rvmrc + +# Used by RuboCop. Remote config files pulled in from inherit_from directive. +# .rubocop-https?--* + +.idea/ \ No newline at end of file diff --git a/.whitesource b/.whitesource new file mode 100644 index 0000000..96443ed --- /dev/null +++ b/.whitesource @@ -0,0 +1,12 @@ +{ + "scanSettings": { + "baseBranches": [] + }, + "checkRunSettings": { + "vulnerableCheckRunConclusionLevel": "failure", + "displayMode": "diff" + }, + "issueSettings": { + "minSeverityLevel": "LOW" + } +} diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..15eb1ae --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,128 @@ +# Contributor Covenant Code of Conduct + +## Our Pledge + +We as members, contributors, and leaders pledge to make participation in our +community a harassment-free experience for everyone, regardless of age, body +size, visible or invisible disability, ethnicity, sex characteristics, gender +identity and expression, level of experience, education, socio-economic status, +nationality, personal appearance, race, religion, or sexual identity +and orientation. + +We pledge to act and interact in ways that contribute to an open, welcoming, +diverse, inclusive, and healthy community. + +## Our Standards + +Examples of behavior that contributes to a positive environment for our +community include: + +* Demonstrating empathy and kindness toward other people +* Being respectful of differing opinions, viewpoints, and experiences +* Giving and gracefully accepting constructive feedback +* Accepting responsibility and apologizing to those affected by our mistakes, + and learning from the experience +* Focusing on what is best not just for us as individuals, but for the + overall community + +Examples of unacceptable behavior include: + +* The use of sexualized language or imagery, and sexual attention or + advances of any kind +* Trolling, insulting or derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or email + address, without their explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Enforcement Responsibilities + +Community leaders are responsible for clarifying and enforcing our standards of +acceptable behavior and will take appropriate and fair corrective action in +response to any behavior that they deem inappropriate, threatening, offensive, +or harmful. + +Community leaders have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions that are +not aligned to this Code of Conduct, and will communicate reasons for moderation +decisions when appropriate. + +## Scope + +This Code of Conduct applies within all community spaces, and also applies when +an individual is officially representing the community in public spaces. +Examples of representing our community include using an official e-mail address, +posting via an official social media account, or acting as an appointed +representative at an online or offline event. + +## Enforcement + +Instances of abusive, harassing, or otherwise unacceptable behavior may be +reported to the community leaders responsible for enforcement at +jtonye@ymail.com. +All complaints will be reviewed and investigated promptly and fairly. + +All community leaders are obligated to respect the privacy and security of the +reporter of any incident. + +## Enforcement Guidelines + +Community leaders will follow these Community Impact Guidelines in determining +the consequences for any action they deem in violation of this Code of Conduct: + +### 1. Correction + +**Community Impact**: Use of inappropriate language or other behavior deemed +unprofessional or unwelcome in the community. + +**Consequence**: A private, written warning from community leaders, providing +clarity around the nature of the violation and an explanation of why the +behavior was inappropriate. A public apology may be requested. + +### 2. Warning + +**Community Impact**: A violation through a single incident or series +of actions. + +**Consequence**: A warning with consequences for continued behavior. No +interaction with the people involved, including unsolicited interaction with +those enforcing the Code of Conduct, for a specified period of time. This +includes avoiding interactions in community spaces as well as external channels +like social media. Violating these terms may lead to a temporary or +permanent ban. + +### 3. Temporary Ban + +**Community Impact**: A serious violation of community standards, including +sustained inappropriate behavior. + +**Consequence**: A temporary ban from any sort of interaction or public +communication with the community for a specified period of time. No public or +private interaction with the people involved, including unsolicited interaction +with those enforcing the Code of Conduct, is allowed during this period. +Violating these terms may lead to a permanent ban. + +### 4. Permanent Ban + +**Community Impact**: Demonstrating a pattern of violation of community +standards, including sustained inappropriate behavior, harassment of an +individual, or aggression toward or disparagement of classes of individuals. + +**Consequence**: A permanent ban from any sort of public interaction within +the community. + +## Attribution + +This Code of Conduct is adapted from the [Contributor Covenant][homepage], +version 2.0, available at +https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. + +Community Impact Guidelines were inspired by [Mozilla's code of conduct +enforcement ladder](https://github.com/mozilla/diversity). + +[homepage]: https://www.contributor-covenant.org + +For answers to common questions about this code of conduct, see the FAQ at +https://www.contributor-covenant.org/faq. Translations are available at +https://www.contributor-covenant.org/translations. diff --git a/Dockerfile b/Dockerfile index e0125fc..880fff7 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,15 +1,15 @@ -FROM ruby:3.0.1-alpine3.13 +FROM ruby:3.0.3-alpine3.13 LABEL maintainer="Tonye Jack <jtonye@ymail.com>" -RUN apk add bash git +RUN apk add bash -COPY Gemfile Gemfile +COPY Gemfile* ./ RUN apk add --no-cache \ --virtual .gem-installdeps \ build-base \ - && gem install bundler --version 2.2.16 \ + && gem install bundler --version 2.3.9 \ && bundle config set --local system 'true' \ && bundle install \ && gem uninstall bundler \ diff --git a/Gemfile b/Gemfile index af6add5..89ed92f 100644 --- a/Gemfile +++ b/Gemfile @@ -1,3 +1,5 @@ +source 'https://rubygems.org' + source 'https://rubygems.org' do - gem 'github_changelog_generator', '1.16.2' + gem 'github_changelog_generator', '1.16.4' end diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 0000000..44aea21 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,105 @@ +GEM + specs: + +GEM + remote: https://rubygems.org/ + specs: + activesupport (7.0.2.3) + concurrent-ruby (~> 1.0, >= 1.0.2) + i18n (>= 1.6, < 2) + minitest (>= 5.1) + tzinfo (~> 2.0) + addressable (2.8.0) + public_suffix (>= 2.0.2, < 5.0) + async (1.30.1) + console (~> 1.10) + nio4r (~> 2.3) + timers (~> 4.1) + async-http (0.56.5) + async (>= 1.25) + async-io (>= 1.28) + async-pool (>= 0.2) + protocol-http (~> 0.22.0) + protocol-http1 (~> 0.14.0) + protocol-http2 (~> 0.14.0) + async-http-faraday (0.11.0) + async-http (~> 0.42) + faraday + async-io (1.33.0) + async + async-pool (0.3.9) + async (>= 1.25) + concurrent-ruby (1.1.9) + console (1.14.0) + fiber-local + faraday (1.10.0) + faraday-em_http (~> 1.0) + faraday-em_synchrony (~> 1.0) + faraday-excon (~> 1.1) + faraday-httpclient (~> 1.0) + faraday-multipart (~> 1.0) + faraday-net_http (~> 1.0) + faraday-net_http_persistent (~> 1.0) + faraday-patron (~> 1.0) + faraday-rack (~> 1.0) + faraday-retry (~> 1.0) + ruby2_keywords (>= 0.0.4) + faraday-em_http (1.0.0) + faraday-em_synchrony (1.0.0) + faraday-excon (1.1.0) + faraday-http-cache (2.2.0) + faraday (>= 0.8) + faraday-httpclient (1.0.1) + faraday-multipart (1.0.3) + multipart-post (>= 1.2, < 3) + faraday-net_http (1.0.1) + faraday-net_http_persistent (1.2.0) + faraday-patron (1.0.0) + faraday-rack (1.0.0) + faraday-retry (1.0.3) + fiber-local (1.0.0) + github_changelog_generator (1.16.4) + activesupport + async (>= 1.25.0) + async-http-faraday + faraday-http-cache + multi_json + octokit (~> 4.6) + rainbow (>= 2.2.1) + rake (>= 10.0) + i18n (1.10.0) + concurrent-ruby (~> 1.0) + minitest (5.15.0) + multi_json (1.15.0) + multipart-post (2.1.1) + nio4r (2.5.8) + octokit (4.22.0) + faraday (>= 0.9) + sawyer (~> 0.8.0, >= 0.5.3) + protocol-hpack (1.4.2) + protocol-http (0.22.5) + protocol-http1 (0.14.2) + protocol-http (~> 0.22) + protocol-http2 (0.14.2) + protocol-hpack (~> 1.4) + protocol-http (~> 0.18) + public_suffix (4.0.6) + rainbow (3.1.1) + rake (13.0.6) + ruby2_keywords (0.0.5) + sawyer (0.8.2) + addressable (>= 2.3.5) + faraday (> 0.8, < 2.0) + timers (4.3.3) + tzinfo (2.0.4) + concurrent-ruby (~> 1.0) + +PLATFORMS + universal-darwin-21 + x86_64-linux + +DEPENDENCIES + github_changelog_generator (= 1.16.4)! + +BUNDLED WITH + 2.3.9 diff --git a/HISTORY.md b/HISTORY.md index fa2e3aa..92bacfe 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,5 +1,117 @@ # Changelog +## [v1.12](https://github.com/tj-actions/github-changelog-generator/tree/v1.12) (2022-02-26) + +[Full Changelog](https://github.com/tj-actions/github-changelog-generator/compare/v1.11...v1.12) + +**Merged pull requests:** + +- Added Gemfile.lock [\#100](https://github.com/tj-actions/github-changelog-generator/pull/100) ([jackton1](https://github.com/jackton1)) +- Update docker/login-action action to v1.13.0 [\#99](https://github.com/tj-actions/github-changelog-generator/pull/99) ([renovate[bot]](https://github.com/apps/renovate)) +- Update tj-actions/sync-release-version action to v11 [\#98](https://github.com/tj-actions/github-changelog-generator/pull/98) ([renovate[bot]](https://github.com/apps/renovate)) +- Updated README.md [\#97](https://github.com/tj-actions/github-changelog-generator/pull/97) ([jackton1](https://github.com/jackton1)) +- Update reviewdog/action-shellcheck action to v1.14 [\#96](https://github.com/tj-actions/github-changelog-generator/pull/96) ([renovate[bot]](https://github.com/apps/renovate)) +- Update docker/build-push-action action to v2.9.0 [\#95](https://github.com/tj-actions/github-changelog-generator/pull/95) ([renovate[bot]](https://github.com/apps/renovate)) +- Update peter-evans/create-pull-request action to v3.12.1 [\#94](https://github.com/tj-actions/github-changelog-generator/pull/94) ([renovate[bot]](https://github.com/apps/renovate)) +- Update docker/build-push-action action to v2.8.0 [\#93](https://github.com/tj-actions/github-changelog-generator/pull/93) ([renovate[bot]](https://github.com/apps/renovate)) +- Update tj-actions/remark action to v2.3 [\#92](https://github.com/tj-actions/github-changelog-generator/pull/92) ([renovate[bot]](https://github.com/apps/renovate)) +- Update tj-actions/remark action to v2.2 [\#91](https://github.com/tj-actions/github-changelog-generator/pull/91) ([renovate[bot]](https://github.com/apps/renovate)) +- Update tj-actions/remark action to v2 [\#90](https://github.com/tj-actions/github-changelog-generator/pull/90) ([renovate[bot]](https://github.com/apps/renovate)) +- Update tj-actions/github-changelog-generator action to v1.11 [\#89](https://github.com/tj-actions/github-changelog-generator/pull/89) ([renovate[bot]](https://github.com/apps/renovate)) +- Upgraded to v1.11 [\#86](https://github.com/tj-actions/github-changelog-generator/pull/86) ([jackton1](https://github.com/jackton1)) + +## [v1.11](https://github.com/tj-actions/github-changelog-generator/tree/v1.11) (2022-01-03) + +[Full Changelog](https://github.com/tj-actions/github-changelog-generator/compare/v1.10...v1.11) + +**Merged pull requests:** + +- Update tj-actions/github-changelog-generator action to v1.10 [\#85](https://github.com/tj-actions/github-changelog-generator/pull/85) ([renovate[bot]](https://github.com/apps/renovate)) +- Upgraded to v1.10 [\#84](https://github.com/tj-actions/github-changelog-generator/pull/84) ([jackton1](https://github.com/jackton1)) + +## [v1.10](https://github.com/tj-actions/github-changelog-generator/tree/v1.10) (2022-01-01) + +[Full Changelog](https://github.com/tj-actions/github-changelog-generator/compare/v1.9...v1.10) + +**Merged pull requests:** + +- Upgraded to v1.9 [\#83](https://github.com/tj-actions/github-changelog-generator/pull/83) ([jackton1](https://github.com/jackton1)) + +## [v1.9](https://github.com/tj-actions/github-changelog-generator/tree/v1.9) (2021-12-28) + +[Full Changelog](https://github.com/tj-actions/github-changelog-generator/compare/v1.8...v1.9) + +**Closed issues:** + +- Error running workflow with PAT token. [\#5](https://github.com/tj-actions/github-changelog-generator/issues/5) + +**Merged pull requests:** + +- Update reviewdog/action-shellcheck action to v1.13 [\#82](https://github.com/tj-actions/github-changelog-generator/pull/82) ([renovate[bot]](https://github.com/apps/renovate)) +- Update docker/login-action action to v1.12.0 [\#81](https://github.com/tj-actions/github-changelog-generator/pull/81) ([renovate[bot]](https://github.com/apps/renovate)) +- Update docker/login-action action to v1.11.0 [\#80](https://github.com/tj-actions/github-changelog-generator/pull/80) ([renovate[bot]](https://github.com/apps/renovate)) +- Update peter-evans/create-pull-request action to v3.12.0 [\#79](https://github.com/tj-actions/github-changelog-generator/pull/79) ([renovate[bot]](https://github.com/apps/renovate)) +- Updated README.md [\#78](https://github.com/tj-actions/github-changelog-generator/pull/78) ([jackton1](https://github.com/jackton1)) +- Update ruby Docker tag to v3.0.3 [\#77](https://github.com/tj-actions/github-changelog-generator/pull/77) ([renovate[bot]](https://github.com/apps/renovate)) +- Add a Codacy badge to README.md [\#76](https://github.com/tj-actions/github-changelog-generator/pull/76) ([codacy-badger](https://github.com/codacy-badger)) +- Update reviewdog/action-shellcheck action to v1.12 [\#75](https://github.com/tj-actions/github-changelog-generator/pull/75) ([renovate[bot]](https://github.com/apps/renovate)) +- Update reviewdog/action-shellcheck action to v1.11 [\#74](https://github.com/tj-actions/github-changelog-generator/pull/74) ([renovate[bot]](https://github.com/apps/renovate)) +- Update reviewdog/action-shellcheck action to v1.10 [\#73](https://github.com/tj-actions/github-changelog-generator/pull/73) ([renovate[bot]](https://github.com/apps/renovate)) +- Updated README.md [\#72](https://github.com/tj-actions/github-changelog-generator/pull/72) ([jackton1](https://github.com/jackton1)) +- Update peter-evans/create-pull-request action to v3.11.0 [\#71](https://github.com/tj-actions/github-changelog-generator/pull/71) ([renovate[bot]](https://github.com/apps/renovate)) +- Updated README.md [\#70](https://github.com/tj-actions/github-changelog-generator/pull/70) ([jackton1](https://github.com/jackton1)) +- Update actions/checkout action to v2.4.0 [\#69](https://github.com/tj-actions/github-changelog-generator/pull/69) ([renovate[bot]](https://github.com/apps/renovate)) +- Bump tj-actions/sync-release-version from 8.7 to 9 [\#68](https://github.com/tj-actions/github-changelog-generator/pull/68) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Update actions/checkout action to v2.3.5 [\#67](https://github.com/tj-actions/github-changelog-generator/pull/67) ([renovate[bot]](https://github.com/apps/renovate)) +- Update tj-actions/verify-changed-files action to v8 [\#66](https://github.com/tj-actions/github-changelog-generator/pull/66) ([renovate[bot]](https://github.com/apps/renovate)) +- Updated README.md [\#65](https://github.com/tj-actions/github-changelog-generator/pull/65) ([jackton1](https://github.com/jackton1)) +- Update reviewdog/action-shellcheck action to v1.9 [\#64](https://github.com/tj-actions/github-changelog-generator/pull/64) ([renovate[bot]](https://github.com/apps/renovate)) +- Update tj-actions/branch-names action to v5 [\#63](https://github.com/tj-actions/github-changelog-generator/pull/63) ([renovate[bot]](https://github.com/apps/renovate)) +- Update docker/setup-buildx-action action to v1.6.0 [\#62](https://github.com/tj-actions/github-changelog-generator/pull/62) ([renovate[bot]](https://github.com/apps/renovate)) +- Update pascalgn/automerge-action action to v0.14.3 [\#61](https://github.com/tj-actions/github-changelog-generator/pull/61) ([renovate[bot]](https://github.com/apps/renovate)) +- Update peter-evans/create-pull-request action to v3.10.1 [\#60](https://github.com/tj-actions/github-changelog-generator/pull/60) ([renovate[bot]](https://github.com/apps/renovate)) +- Update tj-actions/remark action to v1.7 [\#59](https://github.com/tj-actions/github-changelog-generator/pull/59) ([renovate[bot]](https://github.com/apps/renovate)) +- Update docker/build-push-action action to v2.7.0 [\#58](https://github.com/tj-actions/github-changelog-generator/pull/58) ([renovate[bot]](https://github.com/apps/renovate)) +- Update reviewdog/action-shellcheck action to v1.7 [\#57](https://github.com/tj-actions/github-changelog-generator/pull/57) ([renovate[bot]](https://github.com/apps/renovate)) +- Update codacy/codacy-analysis-cli-action action to v4 [\#56](https://github.com/tj-actions/github-changelog-generator/pull/56) ([renovate[bot]](https://github.com/apps/renovate)) +- Update codacy/codacy-analysis-cli-action action to v3 [\#55](https://github.com/tj-actions/github-changelog-generator/pull/55) ([renovate[bot]](https://github.com/apps/renovate)) +- Update docker/setup-buildx-action action to v1.5.1 [\#54](https://github.com/tj-actions/github-changelog-generator/pull/54) ([renovate[bot]](https://github.com/apps/renovate)) +- Update ruby Docker tag to v3.0.2 [\#53](https://github.com/tj-actions/github-changelog-generator/pull/53) ([renovate[bot]](https://github.com/apps/renovate)) +- Update docker/setup-buildx-action action to v1.5.0 [\#51](https://github.com/tj-actions/github-changelog-generator/pull/51) ([renovate[bot]](https://github.com/apps/renovate)) +- Update docker/build-push-action action to v2.6.1 [\#50](https://github.com/tj-actions/github-changelog-generator/pull/50) ([renovate[bot]](https://github.com/apps/renovate)) +- Update docker/setup-buildx-action action to v1.4.1 [\#49](https://github.com/tj-actions/github-changelog-generator/pull/49) ([renovate[bot]](https://github.com/apps/renovate)) +- Update docker/setup-buildx-action action to v1.4.0 [\#48](https://github.com/tj-actions/github-changelog-generator/pull/48) ([renovate[bot]](https://github.com/apps/renovate)) +- Update reviewdog/action-shellcheck action to v1.6 [\#47](https://github.com/tj-actions/github-changelog-generator/pull/47) ([renovate[bot]](https://github.com/apps/renovate)) +- Update docker/login-action action to v1.10.0 [\#46](https://github.com/tj-actions/github-changelog-generator/pull/46) ([renovate[bot]](https://github.com/apps/renovate)) +- Bump tj-actions/verify-changed-files from 6 to 7 [\#45](https://github.com/tj-actions/github-changelog-generator/pull/45) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Updated README.md [\#44](https://github.com/tj-actions/github-changelog-generator/pull/44) ([jackton1](https://github.com/jackton1)) +- Update dependency github\_changelog\_generator to v1.16.4 [\#43](https://github.com/tj-actions/github-changelog-generator/pull/43) ([renovate[bot]](https://github.com/apps/renovate)) +- Update tj-actions/sync-release-version action to v8.7 [\#42](https://github.com/tj-actions/github-changelog-generator/pull/42) ([renovate[bot]](https://github.com/apps/renovate)) +- Update pascalgn/automerge-action action to v0.14.2 [\#41](https://github.com/tj-actions/github-changelog-generator/pull/41) ([renovate[bot]](https://github.com/apps/renovate)) +- Update docker/setup-qemu-action action to v1.2.0 [\#40](https://github.com/tj-actions/github-changelog-generator/pull/40) ([renovate[bot]](https://github.com/apps/renovate)) +- Update docker/build-push-action action to v2.5.0 [\#39](https://github.com/tj-actions/github-changelog-generator/pull/39) ([renovate[bot]](https://github.com/apps/renovate)) +- Bump peter-evans/create-pull-request from 3.9.2 to 3.10.0 [\#38](https://github.com/tj-actions/github-changelog-generator/pull/38) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Update cirrus-actions/rebase action to v1.5 [\#36](https://github.com/tj-actions/github-changelog-generator/pull/36) ([renovate[bot]](https://github.com/apps/renovate)) +- Update dependency github\_changelog\_generator to v1.16.3 [\#35](https://github.com/tj-actions/github-changelog-generator/pull/35) ([renovate[bot]](https://github.com/apps/renovate)) +- Bump peter-evans/create-pull-request from 3.9.1 to 3.9.2 [\#33](https://github.com/tj-actions/github-changelog-generator/pull/33) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump actions/checkout from 2 to 2.3.4 [\#32](https://github.com/tj-actions/github-changelog-generator/pull/32) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump docker/login-action from 1 to 1.9.0 [\#31](https://github.com/tj-actions/github-changelog-generator/pull/31) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump docker/setup-qemu-action from 1 to 1.1.0 [\#30](https://github.com/tj-actions/github-changelog-generator/pull/30) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump peter-evans/create-pull-request from 3 to 3.9.1 [\#29](https://github.com/tj-actions/github-changelog-generator/pull/29) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump docker/setup-buildx-action from 1 to 1.3.0 [\#28](https://github.com/tj-actions/github-changelog-generator/pull/28) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Bump docker/build-push-action from 2 to 2.4.0 [\#27](https://github.com/tj-actions/github-changelog-generator/pull/27) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Update tj-actions/sync-release-version action to v8.6 [\#25](https://github.com/tj-actions/github-changelog-generator/pull/25) ([renovate[bot]](https://github.com/apps/renovate)) +- Bump tj-actions/github-changelog-generator from v1.6 to v1.8 [\#24](https://github.com/tj-actions/github-changelog-generator/pull/24) ([dependabot[bot]](https://github.com/apps/dependabot)) +- Upgraded to v1.8 [\#23](https://github.com/tj-actions/github-changelog-generator/pull/23) ([jackton1](https://github.com/jackton1)) + +## [v1.8](https://github.com/tj-actions/github-changelog-generator/tree/v1.8) (2021-05-04) + +[Full Changelog](https://github.com/tj-actions/github-changelog-generator/compare/v1.7...v1.8) + +**Merged pull requests:** + +- Upgraded to v1.7 [\#22](https://github.com/tj-actions/github-changelog-generator/pull/22) ([jackton1](https://github.com/jackton1)) + ## [v1.7](https://github.com/tj-actions/github-changelog-generator/tree/v1.7) (2021-05-04) [Full Changelog](https://github.com/tj-actions/github-changelog-generator/compare/v1.6...v1.7) diff --git a/README.md b/README.md index 6c78b78..f602504 100644 --- a/README.md +++ b/README.md @@ -1,53 +1,51 @@ -[![CI](https://github.com/tj-actions/github-changelog-generator/actions/workflows/test.yml/badge.svg)](https://github.com/tj-actions/github-changelog-generator/actions/workflows/test.yml) [![Update release version.](https://github.com/tj-actions/github-changelog-generator/actions/workflows/sync-release-version.yml/badge.svg)](https://github.com/tj-actions/github-changelog-generator/actions/workflows/sync-release-version.yml) <a href="https://github.com/search?q=tj-actions+github-changelog-generator+path%3A.github%2Fworkflows+language%3AYAML&type=code" target="_blank" title="Public workflows that use this action."><img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fapi-git-master.endbug.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3Dtj-actions%2Fgithub-changelog-generator%26badge%3Dtrue" alt="Public workflows that use this action."></a> +[![Codacy Badge](https://api.codacy.com/project/badge/Grade/3efa85ca84e3495a89a081f46df72101)](https://app.codacy.com/gh/tj-actions/github-changelog-generator?utm_source=github.com\&utm_medium=referral\&utm_content=tj-actions/github-changelog-generator\&utm_campaign=Badge_Grade_Settings) +[![CI](https://github.com/tj-actions/github-changelog-generator/actions/workflows/test.yml/badge.svg)](https://github.com/tj-actions/github-changelog-generator/actions/workflows/test.yml) +[![Update release version.](https://github.com/tj-actions/github-changelog-generator/actions/workflows/sync-release-version.yml/badge.svg)](https://github.com/tj-actions/github-changelog-generator/actions/workflows/sync-release-version.yml) +[![Public workflows that use this action.](https://img.shields.io/endpoint?url=https%3A%2F%2Fused-by.vercel.app%2Fapi%2Fgithub-actions%2Fused-by%3Faction%3Dtj-actions%2Fgithub-changelog-generator%26badge%3Dtrue)](https://github.com/search?o=desc\&q=tj-actions+github-changelog-generator+path%3A.github%2Fworkflows+language%3AYAML\&s=\&type=Code) -[github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator) ----------------------------- +## github-changelog-generator -Github CHANGELOG generator +Generate CHANGELOG/HISTORY markdown files for your project ```yaml ... steps: - uses: actions/checkout@v2 - name: Generate CHANGELOG - uses: tj-actions/github-changelog-generator@v1.7 + uses: tj-actions/github-changelog-generator@v1.12 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) <br /> or a repo scoped <br /> [Personal Access Token](https://docs.github.com/en/free-pro-team@latest/github/authenticating-to-github/creating-a-personal-access-token) | +| 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) <br /> or a repo scoped <br /> [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. | +* Free software: [MIT license](LICENSE) +If you feel generous and want to show some extra appreciation: -* Free software: [MIT license](LICENSE) - +[![Buy me a coffee][buymeacoffee-shield]][buymeacoffee] -Features --------- +[buymeacoffee]: https://www.buymeacoffee.com/jackton1 -* Generates Change logs using [github-changelog-generator](github-changelog-generator/github-changelog-generator) +[buymeacoffee-shield]: https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png - -Credits -------- +## Credits This package was created with [Cookiecutter](https://github.com/cookiecutter/cookiecutter). +* [github-changelog-generator](https://github.com/github-changelog-generator/github-changelog-generator) - -Report Bugs ------------ +## Report Bugs Report bugs at https://github.com/tj-actions/github-changelog-generator/issues. If you are reporting a bug, please include: -* Your operating system name and version. -* Any details about your workflow that might be helpful in troubleshooting. -* Detailed steps to reproduce the bug. +* Your operating system name and version. +* Any details about your workflow that might be helpful in troubleshooting. +* Detailed steps to reproduce the bug. diff --git a/action.yml b/action.yml index d687174..7e642a1 100644 --- a/action.yml +++ b/action.yml @@ -1,5 +1,5 @@ -name: Github CHANGELOG.md generator -description: Github CHANGELOG generator +name: Github Changelog or History Generator +description: Github Changelog/History Generator author: tj-actions inputs: token: diff --git a/entrypoint.sh b/entrypoint.sh index 937c5f1..c14b0e8 100644 --- a/entrypoint.sh +++ b/entrypoint.sh @@ -7,6 +7,6 @@ REPOSITORY=$(cut -d '/' -f 2 <<< "$GITHUB_REPOSITORY") echo "Running github_changelog_generator with the following settings:" echo "Repository: $REPOSITORY" echo "Repository owner: $GITHUB_REPOSITORY_OWNER" -echo "Output: $2" +echo "Output: $INPUT_OUTPUT" -github_changelog_generator -u "$GITHUB_REPOSITORY_OWNER" -p "$REPOSITORY" -t "$1" --base "" --output="$2" +github_changelog_generator -u "$GITHUB_REPOSITORY_OWNER" -p "$REPOSITORY" -t "$INPUT_TOKEN" --base "" --output="$INPUT_OUTPUT" diff --git a/renovate.json b/renovate.json index 4a47c4b..36d794a 100644 --- a/renovate.json +++ b/renovate.json @@ -21,7 +21,7 @@ }, "packageRules": [ { - "matchUpdateTypes": ["major", "minor", "patch", "pin", "digest"], + "matchUpdateTypes": ["minor", "patch", "pin", "digest"], "automerge": true, "rebaseWhen": "behind-base-branch", "addLabels": [ @@ -33,7 +33,7 @@ "matchLanguages": [ "docker" ], - "matchUpdateTypes": ["major", "minor", "patch", "pin", "digest"], + "matchUpdateTypes": ["minor", "patch", "pin", "digest"], "rebaseWhen": "behind-base-branch", "addLabels": [ "automerge"