Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/actionsdesk/github-actions-details-action
Collect and comment with details about GitHub Actions on PRs
https://github.com/actionsdesk/github-actions-details-action
automation github-actions
Last synced: 4 months ago
JSON representation
Collect and comment with details about GitHub Actions on PRs
- Host: GitHub
- URL: https://github.com/actionsdesk/github-actions-details-action
- Owner: ActionsDesk
- License: mit
- Created: 2021-05-27T07:07:14.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-01T09:27:43.000Z (4 months ago)
- Last Synced: 2024-11-07T08:03:52.061Z (4 months ago)
- Topics: automation, github-actions
- Language: JavaScript
- Homepage:
- Size: 1.92 MB
- Stars: 4
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
- Contributing: .github/contributing.md
- License: license
- Code of conduct: .github/code_of_conduct.md
- Codeowners: .github/codeowners
- Security: .github/security.md
Awesome Lists containing this project
README
# github-actions-details-action
> Collect and comment with details about GitHub Actions on PRs
[](https://github.com/ActionsDesk/github-actions-details-action/actions/workflows/test.yml) [](https://github.com/ActionsDesk/github-actions-details-action/actions/workflows/codeql.yml) [](https://github.com/prettier/prettier)
## Usage
```yml
name: Post Action detailson:
pull_request:
types: [opened, synchronize]
paths: [github-actions-allow-list.yml]jobs:
post-details:
runs-on: ubuntu-latestpermissions:
contents: read
issues: write
pull-requests: writesteps:
- name: Checkout
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11- name: Setup node
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8
with:
node-version: 20
cache: 'npm'- name: Add GitHub Action Details from PR
uses: ActionsDesk/github-actions-details-action@c49711d95dd1d7b855baa08ecac42bc9b4528a27
with:
search_token: ${{ secrets.SEARCH_TOKEN }}
# same as defined under `on.pull_requests.paths`
allow_list_path: github-actions-allow-list.yml
```### Action Inputs
| Name | Description | Default | Required |
| :---------------- | :------------------------------------------------------------------------------------------------------------------------ | :------------------------------ | :------- |
| `token` | [`GITHUB_TOKEN`](https://docs.github.com/en/actions/reference/authentication-in-a-workflow#about-the-github_token-secret) | `${{ github.token }}` | `true` |
| `search_token` | GitHub Personal Access Token ([PAT]) with no scopes | | `true` |
| `allow_list_path` | Path to the GitHub Actions allow list YML within the repository | `github-actions-allow-list.yml` | `false` |## License
- [MIT License](./license)
[pat]: https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token 'Personal Access Token'