pablof -- a Productive Assistant for a Better Life OF you, your team, your family and our world.

This is a custom action for GitHub Actions to help you work with GitHub Issues and Projects (V2).

• Usage
• Feature - Milestone Issue
  • Action - Create Milestone Issue
  • Action - Sync Milestone Issue
• Feature - Derived Issue
  • Action - Derive Issue

name: pablof

on:
  issues:
    types: [opened]
  milestone:
    types: [created, opened, edited, closed, deleted]

jobs:
  pablof:
    runs-on: ubuntu-latest
    steps:
      - uses: a24k/pablof@milestone-issue
        with:
          token: ${{ secrets.GH_TOKEN }}

Milestone is a better way to track progress on groups of issues. It is very useful for managing project with multiple issues, but there is not a sufficient way to describe or discuss about Milestone itself in detail.

Milestone Issue is a issue linked 1:1 to Milestone.

As shown in the figure below, each Milestone has a linked Milestone Issue. Each Issues in the Milestone should be tracked from the Milestone Issue. All Issues on the Milestone consists of a single tree with the Milestone Issue as its root.

flowchart LR
  ma[Milestone A]
  mia[Milestone Issue A]

  ma -- 1:1 --- mia

  mb[Milestone B]
  mib[Milestone Issue B]

  mb -- 1:1 --- mib

  ti1[Task Issue 1]
  sia[Sub Issue a]
  sib[Sub Issue b]

  ti2[Task Issue 2]
  sic[Sub Issue c]
  sid[Sub Issue d]

  ti3[Task Issue 3]

  ti4[Task Issue 4]

  mia -- track --> ti1
  ti1 -- track --> sia
  ti1 -- track --> sib

  mia -- track --> ti2
  ti2 -- track --> sic
  ti2 -- track --> sid

  mib -- track --> ti3
  mib -- track --> ti4

1. list issues linked with the Milestone
2. filter issues by trackedInIssues.totalCount === 0
3. the first issue, in order of CREATED_AT ASC, is the Milestone Issue

Automatically create a Milestone Issue when a Milestone is created. The created Milestone Issue will inherit the title and body of the Milestone.

If you have linked Projects on the Repository, this action will add the Milestone Issue to every linked Projects.

If the Project has a Field named Status, this action will set the value of Status according to following rules in the order written.

1. If the Status Field has an Option named Milestone, set Status to Milestone.
2. If the Status Field has an Option named Project, set Status to Project.
3. Otherwise, set Status to first (most left) one.

If the Project has a Field name matched with /^(Begin|Start) [dD]ate$/, this action will set the field value to createdAt of Milestone. Only affects for the first Field matched.

If the Project has a Field name matched with /^(Due|End|Finish|Target) [dD]ate$/, this action will set the field value to dueOn of Milestone. Only affects for the first Field matched.

Automatically updates the Milestone Issue when a Milestone is updated. The updated Milestone Issue will have the same title and state as the Milestone.

If you have linked Items on the Milestone Issue, this action will update Items linked with Projects.

If the Project has a Field name matched with /^(Due|End|Finish|Target) [dD]ate$/, this action will set the field value to dueOn of Milestone. Only affects for the first Field matched.

When we are trying to achieve something, it is very important to break down the task.

If a newly opened Issue Sub Issue a is tracked 1:1 from the another Issue Task Issue 1, we consider it is derived from Task Issue 1. Typically, this situation occurs when a new Issue is created by clicking "Convert to issue" at the end of each items on the Tasklist.

flowchart LR
  ti1[Task Issue 1]
  sia[Sub Issue a]
  sib[Sub Issue b]

  ti1 -- track --> sia
  ti1 -- track --> sib

When a new Issue derived from another Issue, this action copies the Parent Issue's attributes about Labels, Milestone and Projects.

If the Parent Issue linked with Projects, this action will add the Derived Issue to every linked Projects and copy Field Values of Parent Project Items.

If the Parent Project Item has a Field named Status, this action will set the value of Status according to following rules in the order written.

1. Set Status to first (most left) one except named Milestone or Project.
2. Otherwise, set the same Status as the Parent Project Item.