This repository represents an attempt to manage a Github-based development workflow. Initially, it will attempt to work for a single-user workflow, but should keep an eye toward team/multi-user workflows.
All TODO items/ideas are added as Github Issues on this repository.
Automation of this project is driven by the addition of Github Labels. To mark an issue as done, set the label to done, etc. Everything else (closing the issue, updating labels, etc.) should be handled automatically.
The following repository projects exist:
Optionally, the repository can be connected to a JIRA board, presently: https://openedx.atlassian.net/secure/RapidBoard.jspa?rapidView=689
When issues are created:
- automatically apply label: triage
- automatically add issue to project list: backlog/TODO
- automatically create a JIRA ticket to track this issue: CENG/backlog
If an issue is created with a title starting with a Conventional Commit prefix [1], we automatically apply the corresponding Github Label.
We also flag potential "parking lot" discussions with the prefix:
When work is started:
- manually apply label: progress
- automatically remove label: done todo triage
- automatically move issue to project list: worklog/Doing
- automatically transition JIRA ticket "In Progress": CENG/Kanban
When work is finished:
- manually apply label: done
- automatically remove label: progress todo triage
- automatically move issue to project list: backlog/Done worklog/Done
- automatically close issue: closed
- automatically close JIRA ticket: CENG/Kanban
When a sprint is started:
- manually assign issue to owner
- manually add issues to project list: worklog/TODO
When a sprint is ended:
- manually archive project list: worklog/Done
When an interrupt occurs:
- manually add issue to project list: worklog/TODO
- manually assign issue to owner
To enable JIRA integration, the following Repository Secrets must be added:
JIRA_API_TOKEN- To create a personal token, visit https://id.atlassian.com/manage/api-tokens
JIRA_BASE_URL- This is the base of your JIRA installation, like https://MY-PROJECT.atlassian.net
JIRA_USER_EMAIL- This is the email of the account associated with the access token.
- create automated/manual actions to snapshot daily standup, weekly sprint, etc.
- We often refer to a "sprint" and a "week" interchangeably.