Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/kineticcafe/actions-dco
GitHub Action that enforces Developer Certificate of Origin sign-off on Pull Requests
https://github.com/kineticcafe/actions-dco
actions github-actions typescript
Last synced: about 2 months ago
JSON representation
GitHub Action that enforces Developer Certificate of Origin sign-off on Pull Requests
- Host: GitHub
- URL: https://github.com/kineticcafe/actions-dco
- Owner: KineticCafe
- License: other
- Created: 2023-05-24T15:18:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-04-16T22:15:36.000Z (9 months ago)
- Last Synced: 2024-05-01T05:44:30.517Z (9 months ago)
- Topics: actions, github-actions, typescript
- Language: TypeScript
- Size: 1.37 MB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: Changelog.md
- Contributing: Contributing.md
- License: licenses/APACHE-2.0.txt
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# @KineticCafe/actions-dco
Enforce the presence of commit sign-offs on pull requests, indicating that the
contributor to a project certifies that they are permitted to contribute to the
project. The sign-off line represents certification of the [Developer
Certificate of Origin][dco].
Bot user contributions are automatically exempted.
## Example Usage
```yaml
name: DCO Check
on:
pull_request:
jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: KineticCafe/actions-dco@v1
```
## Inputs
- `repo-token`: The GitHub token for use with this action. It must have
sufficient permissions to read pull request details.
Default: `${{ github.token }}`
- `exempt-authors`: A whitespace separated list of email exemption patterns
indicating an implied DCO sign-off (the contributors work for the company
managing the project, for example). Permitted pattern formats are exact emails
(`[email protected]`) or domain patterns (`@example.org`). Patterns that do not
match this will be printed as warnings and ignored.
`exempt-authors` are applied only for the commit _author_. The commit
_committer_ cannot exempt other peoples' contributions.
```yaml
name: DCO Check
on:
pull_request:
jobs:
check:
runs-on: ubuntu-latest
steps:
- uses: KineticCafe/actions-dco@v1
with:
exempt-authors: |
[email protected]
@example.com
```
## Contributing
@KineticCafe/actions-dco [welcomes contributions][]. This project, like all
Kinetic Commerce [open source projects][], is under the Kinetic Commerce Open
Source [Code of Conduct][].
This project is licensed under the Apache License, version 2.0 and requires
certification via a Developer Certificate of Origin. See [Licence.md][] for
more details.
## Releasing
Releases are prepared with `@vercel/ncc` to produce a single file which must
be committed to `dist/`. Run `pnpm package` or `pnpm all` to produce this
file.
[welcomes contributions]: https://github.com/KineticCafe/actions-dco/blob/main/Contributing.md
[code of conduct]: https://github.com/KineticCafe/code-of-conduct
[open source projects]: https://github.com/KineticCafe
[licence.md]: https://github.com/KineticCafe/actions-dco/blob/main/Licence.md
[dco]: https://developercertificate.org