This repository has been archived by the owner on Sep 27, 2024. It is now read-only.
add changelog ci #8
Workflow file for this run
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Changelog CI | |
| on: | |
| push: | |
| branches: | |
| - add-changelog-ci | |
| pull_request: | |
| types: [ opened ] | |
| # Optionally you can use `workflow_dispatch` to run Changelog CI Manually | |
| workflow_dispatch: | |
| inputs: | |
| release_version: | |
| description: 'Set Release Version' | |
| required: true | |
| default: "1.0.0" | |
| jobs: | |
| build: | |
| # Use self-hosted runners | |
| runs-on: ubuntu-latest | |
| # These permissions are needed to interact with GitHub's OIDC Token endpoint. | |
| permissions: | |
| id-token: write | |
| contents: write | |
| repository-projects: read | |
| pull-requests: write | |
| steps: | |
| # Checks-out your repository | |
| - uses: actions/checkout@v2 | |
| - name: Run Changelog CI | |
| uses: saadmk11/changelog-ci@33b9a3b76588f9c01e4d46c560ec030fba92b748 | |
| with: | |
| # Optional, you can provide any name for your changelog file, | |
| # We currently support Markdown (.md) and reStructuredText (.rst) files | |
| # defaults to `CHANGELOG.md` if not provided. | |
| changelog_filename: CHANGELOG.md | |
| # Optional, only required when you want more customization | |
| # e.g: group your changelog by labels with custom titles, | |
| # different version prefix, pull request title and version number regex etc. | |
| # config file can be in JSON or YAML format. | |
| config_file: .changelog-ci-config.yaml | |
| # Optional, This will be used to configure git | |
| # defaults to `github-actions[bot]` if not provided. | |
| committer_username: 'Changelog CI' | |
| committer_email: 'batcave-gotham@revacomm.com' | |
| ## Optional, only required when you want to run Changelog CI | |
| ## on an event other than `pull_request` event. | |
| ## In this example `release_version` is fetched from `workflow_dispatch` events input. | |
| ## You can use any other method to fetch the release version | |
| ## such as environment variable or from output of another action | |
| #release_version: ${{ github.event.inputs.release_version }} | |
| release_version: 1.0.0 | |
| # Optional |