Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/thomasvjoseph/manual-approval
https://github.com/thomasvjoseph/manual-approval
Last synced: 29 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/thomasvjoseph/manual-approval
- Owner: thomasvjoseph
- License: mit
- Created: 2024-12-06T11:09:12.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2024-12-06T11:17:28.000Z (about 1 month ago)
- Last Synced: 2024-12-06T12:23:01.367Z (about 1 month ago)
- Language: Python
- Size: 2.93 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Manual Approval GitHub Action
Hold up the GitHub Actions workflow and request manual confirmation from selected approvers to continue.
This GitHub Action allows you to create an issue on your repository that requires manual approval through comments. Assignees of the issue (or any user if no assignees are set) can approve or reject the issue by commenting `"yes"` or `"no"` on the issue.
The action can also be configured to require a minimum number of approvals if multiple assignees are set.
## Features
- Creates an issue for manual approval.
- Only allows assignees (or anyone if no assignees are specified) to approve or reject.
- Tracks approvals and rejections based on user comments.
- Optionally requires a minimum number of approvals for closing the issue.
## Inputs
| Input Name | Description | Default |
| ------------------- | ------------------------------------------------------------------------ | --------------------- |
| `INPUT_TITLE` | Title of the issue to be created. | `Manual Approval` |
| `INPUT_BODY` | Body of the issue. This should include instructions for users to approve or reject. | `Provide approval as yes or no.` |
| `INPUT_LABELS` | A comma-separated list of labels to apply to the issue. | `""` |
| `INPUT_ASSIGNEES` | A comma-separated list of assignees for the issue. If not provided, anyone can approve/reject. | `""` |
| `INPUT_TIMEOUT` | Timeout period (in minutes) for waiting for approval. If no comment is received within this time, the issue will be closed. | `30` |
| `INPUT_MIN_APPROVERS`| Minimum number of approvals required to close the issue. Only applicable when there are multiple assignees. | `1` |
## Usage
### Workflow Example
```yaml
name: Manual Approval Workflow
on:
push:
branches:
- main
permissions:
id-token: write
issues: write
contents: read
jobs:
approval:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v4
- name: Request approval
uses: yourusername/[email protected]
with:
INPUT_TITLE: "Manual Approval Request"
INPUT_BODY: "Please approve or reject by commenting 'yes' or 'no'."
INPUT_ASSIGNEES: "user1,user2"
INPUT_MIN_APPROVERS: 1
INPUT_TIMEOUT: 10
- name: Run a one-line script
run: echo Hello, world!
```
## How it Works
1. When the workflow is triggered, it creates an issue with the title and body you provide.
2. If you have set assignees, only those users can approve or reject the issue by commenting "yes" or "no".
3. If the number of approvals meets the INPUT_MIN_APPROVERS threshold, the issue will be closed with a success message.
4. If any assignee comments "no", the issue will be closed with a rejection message.
5. If no approval is received within the specified timeout (INPUT_TIMEOUT), the issue will be closed with a failure message.
## Example Use Cases
• Single Assignee: If you have only one assignee, the workflow will proceed when that assignee approves or rejects the issue.
• Multiple Assignees: If you have multiple assignees, you can set a minimum number of approvals required to close the issue.
## Contributing
Feel free to fork this repository, make improvements, and submit pull requests. If you have suggestions or find any bugs, open an issue to discuss them.
## License
This project is licensed under the MIT License. See [LICENSE](LICENSE) for more details.
## Author:
thomas joseph
- [linkedin](https://www.linkedin.com/in/thomas-joseph-88792b132/)
- [medium](https://medium.com/@thomasvjoseph)