{"id":16941074,"url":"https://github.com/greenpau/contributor-compliance-action","last_synced_at":"2026-05-18T08:03:14.576Z","repository":{"id":83535340,"uuid":"450982793","full_name":"greenpau/contributor-compliance-action","owner":"greenpau","description":"✅ Inspects a pull request for the compliance with OSS contributing guidelines. It covers CLA, Signed-off-by, and other aspects of OSS contributing.","archived":false,"fork":false,"pushed_at":"2022-01-23T20:46:13.000Z","size":44,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-05-02T05:08:36.453Z","etag":null,"topics":["contributor-license-agreement","github-action","github-actions","github-actions-ci","signed-off","tools"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/greenpau.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null},"funding":{"github":["greenpau"]}},"created_at":"2022-01-23T02:09:05.000Z","updated_at":"2022-01-23T17:56:30.000Z","dependencies_parsed_at":null,"dependency_job_id":"3b893699-a6e9-4dda-b8cb-a1d607f04442","html_url":"https://github.com/greenpau/contributor-compliance-action","commit_stats":{"total_commits":43,"total_committers":2,"mean_commits":21.5,"dds":"0.046511627906976716","last_synced_commit":"2fb48086a470edec8ff1181abb8ddd557d4d4b5f"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenpau%2Fcontributor-compliance-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenpau%2Fcontributor-compliance-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenpau%2Fcontributor-compliance-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/greenpau%2Fcontributor-compliance-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/greenpau","download_url":"https://codeload.github.com/greenpau/contributor-compliance-action/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244174300,"owners_count":20410481,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["contributor-license-agreement","github-action","github-actions","github-actions-ci","signed-off","tools"],"created_at":"2024-10-13T21:08:39.679Z","updated_at":"2026-05-18T08:03:14.516Z","avatar_url":"https://github.com/greenpau.png","language":"Python","funding_links":["https://github.com/sponsors/greenpau"],"categories":[],"sub_categories":[],"readme":"# contributor-compliance-action\n\nInspects a pull request for the compliance with OSS contributing guidelines.\nIt covers CLA, Signed-off-by, and other aspects of OSS contributing.\n\n🚩This github action DOES NOT require passing security token to\nperform its assessment.\n\n\u003c!-- begin-markdown-toc --\u003e\n## Table of Contents\n\n* [Overview](#overview)\n* [Getting Started](#getting-started)\n* [Commit Message Tags](#commit-message-tags)\n\n\u003c!-- end-markdown-toc --\u003e\n\n## Overview\n\n1. Checks whether a contributor already **signed CLA** in previous PRs\n2. If a contributor did not sign CLA, the contributor must do so as part of\n  the first commit in the PR. Otherwise, you might be accepting an earlier\n  commit without CLA consent\n3. Checks whether the commits are **signed by the individual** who signed\n  the CLA\n4. Checks whether the final commit contains a **reference to an issue**\n  related to the committed work. If it fails, that might indicate the\n  contributor did not previously discuss the work\n5. Checks that **the number of commits** in a PR does not exceed configured\n  number\n6. Checks that the changes in the commit **do not modify Github workflows**\n\n**Note**: The above checks can be disabled (1) by modifying Github workflow\n  or (2) by adding **commit message tags** to the last commit in a PR.\n\n📗Further, this action allows to see the commits in a slightly different\nway as it shows in Github PR pages.\n\n## Getting Started\n\nAdd the following Github workflow to your project,\ne.g. `.github/workflows/contributors.yml`. This workflow assumes the\npull requests are going to be made against `main` branch. You may want to\nmodify it.\n\n```\non:\n  pull_request:\n    branches:\n    - main\n\njobs:\n  inspect_pr:\n    runs-on: ubuntu-latest\n    name: PR Inspection\n    steps:\n      - uses: actions/checkout@v2\n      - id: inspection\n        uses: greenpau/contributor-compliance-action@v1.0.18\n        with:\n          cla_consent_required: true\n          signed_off_required: true\n          issue_required: true\n          max_commits: 1\n          cla_consent_path: assets/cla/consent.yaml\n```\n\n## Commit Message Tags\n\nIf a commit message contains the `CONTRIBUTOR_COMPLIANCE=disabled`, then\nthis Github Action will still perform all the checks. However, it will not\nfail the PR request if it finds non-compliance.\n\n```\ndocs: update README.md\n\nCONTRIBUTOR_COMPLIANCE=disabled\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreenpau%2Fcontributor-compliance-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgreenpau%2Fcontributor-compliance-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgreenpau%2Fcontributor-compliance-action/lists"}