https://github.com/cloudaper/epics-action
Automatically update task list when referenced issue is closed
https://github.com/cloudaper/epics-action
actions agile github-actions issues project-management
Last synced: 2 months ago
JSON representation
Automatically update task list when referenced issue is closed
- Host: GitHub
- URL: https://github.com/cloudaper/epics-action
- Owner: cloudaper
- Created: 2020-05-02T15:55:41.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-08-19T15:59:37.000Z (over 1 year ago)
- Last Synced: 2025-08-19T03:09:32.012Z (7 months ago)
- Topics: actions, agile, github-actions, issues, project-management
- Language: JavaScript
- Homepage:
- Size: 719 KB
- Stars: 58
- Watchers: 2
- Forks: 10
- Open Issues: 7
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Epic issues for GitHub
> [!NOTE]
> #### This action vs. GitHub task lists
>
> This action was created before GitHub introduced the [task lists](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/about-task-lists) feature, which esentially does the same thing: synces the status of a task list item with a reference to an issue based on the issues state.
>
> However, you can still use this action for the auto close epic feature.
>
> There is even more sopishicated [tasklists](https://docs.github.com/en/issues/managing-your-tasks-with-tasklists) (not the missing space) feature in works at private beta, so the future of this action is uncertain, but for now it should remain functional.
This action allows you to create epic issues on GitHub. Simply label an issue as `epic` and reference another issues in the task list:
```markdown
This is an epic issue. List of individual issues is below:
- [ ] First issue #1
- [ ] Another issue (#2)
- [ ] Last issue #3 (not that important)
```
The action automatically updates the task list when referenced issue is closed (or reopened).
## Inputs
- **`github-token`**
the GitHub token secret (use `${{ secrets.GITHUB_TOKEN }}` in action YAML)
_required_
- **`epic-label-name`**
name of the label you want to use for epic issues
_default: `epic`_
- **`auto-close-epic`**
auto close epic when all referenced issues are closed
_default: `false`_
## Example usage
```yaml
name: Update epics
on:
issues:
types: [opened, closed, reopened]
jobs:
epics:
runs-on: ubuntu-latest
name: Update epic issues
steps:
- name: Run epics action
uses: cloudaper/epics-action@v1
with:
github-token: ${{ secrets.GITHUB_TOKEN }}
epic-label-name: feature
auto-close-epic: true
```