Update documentation #497
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: "CLA Assistant" | |
| on: | |
| issue_comment: | |
| types: [created] | |
| pull_request_target: | |
| types: [opened,closed,synchronize] | |
| # explicitly configure permissions, in case your GITHUB_TOKEN workflow permissions are set to read-only in repository settings | |
| permissions: | |
| actions: write | |
| contents: read | |
| pull-requests: write | |
| statuses: write | |
| jobs: | |
| CLAAssistant: | |
| runs-on: ubuntu-latest | |
| steps: | |
| - name: "CLA Assistant" | |
| if: (github.event.comment.body == 'recheck' || contains(github.event.comment.body, 'I have read the CLA Document and I hereby sign the CLA')) || github.event_name == 'pull_request_target' | |
| uses: contributor-assistant/github-action@v2.4.0 | |
| env: | |
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
| # The below token has repo scope for the project configured further below to store signatures. | |
| PERSONAL_ACCESS_TOKEN: ${{ secrets.CADET_CLA_SIGNATURES }} | |
| PATH_TO_CLA: 'https://github.com/cadet/cadet-core/blob/master/CLA.md' | |
| with: | |
| path-to-signatures: 'signatures/version1/signatures.json' | |
| path-to-document: $PATH_TO_CLA | |
| # branch should not be protected | |
| branch: 'main' | |
| allowlist: dependabot[bot] | |
| # the followings are the optional inputs - If the optional inputs are not given, then default values will be taken | |
| # 👇 the remote organization and repo where the signatures should be stored | |
| remote-organization-name: cadet | |
| remote-repository-name: cla-signatures | |
| #create-file-commit-message: 'For example: Creating file for storing CLA Signatures' | |
| #signed-commit-message: 'For example: $contributorName has signed the CLA in $owner/$repo#$pullRequestNo' | |
| custom-notsigned-prcomment: | | |
| Thank you for your submission, we really appreciate it! | |
| Like many open-source projects we ask that you sign our [Contributor License Agreement](${{ env.PATH_TO_CLA }}) before we can accept your contribution. | |
| To sign, please post two separate comments based on the following templates 👇 | |
| 1. Comment: | |
| ---- | |
| ```markdown | |
| - [ ] The CADET maintainers know my real name. | |
| At least one of the following two applies: | |
| - [ ] The CADET maintainers know my current employer. | |
| - [ ] I am *not* making this contribution on behalf of my current employer. | |
| ``` | |
| ---- | |
| 2. Comment: | |
| custom-pr-sign-comment: I have read the CLA Document and I hereby sign the CLA. | |
| #custom-allsigned-prcomment: 'pull request comment when all contributors has signed, defaults to **CLA Assistant Lite bot** All Contributors have signed the CLA.' | |
| # 👇 prevent contributors from revoking signatures after the merge (this is also the default) | |
| lock-pullrequest-aftermerge: true | |
| #use-dco-flag: true - If you are using DCO instead of CLA |