When activated and configured, a check will be added to every PR making sure your CLA has been signed by all committers. If a committer has not signed your CLA, the check will fail.
After signing the CLA, contributors can comment "I've signed the CLA!" on the PR to re-run the test suite.
This is intended for Shopify repositories only.
Add the following workflow to your repository:
# .github/workflows/cla.yml
name: Contributor License Agreement (CLA)
on:
pull_request_target:
types: [opened, synchronize]
issue_comment:
types: [created]
jobs:
cla:
runs-on: ubuntu-latest
if: |
(github.event.issue.pull_request
&& !github.event.issue.pull_request.merged_at
&& contains(github.event.comment.body, 'signed')
)
|| (github.event.pull_request && !github.event.pull_request.merged)
steps:
- uses: Shopify/shopify-cla-action@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
cla-token: ${{ secrets.CLA_TOKEN }}| Name | Required | Default | Description |
|---|---|---|---|
github-token |
true |
$GITHUB_TOKEN | The token to be used with GitHub interactions |
cla-token |
true |
Provided by github-actions repository secret | The token to access cla.shopify.com |
None