Scheduled Milestones

A GitHub action that can auto-create weekly milestones.

The folks at ReadMe utilized this to internally organize our weekly releases.

This action is similar to github-action-milestone-schedule but offers some friendlier configuration options.

Options

This action supports the following options:

title

A prefix for your scheduled milestone. All created milestones will look like Up for Review (August 27), where "Up for Review" is your title.

• Required: Yes
• Type: string
• Example: Up for Review

days

A comma-separated list of the days of the upcoming week that you want milestones for. For example if you want milestones for every Tuesday and Thursday of the week you would set this to Tuesday,Thursday. Just Tuesday? Set it to Tuesday. Fridays? I mean I guess if you're living on the edge, then Friday.

• Required: Yes
• Type: string

date_options

This option allows you to control how the dates in your milestone titles should look. The options here should be a JSON-encoded string of the options that you would normally supply to Date.toLocaleDateString(). Check out the docs on MDN for toLocaleDateString for details.

Note: If you do not configure this, the default format for dates in in your milestones will look like M/D/YYYY.

• Required: Yes
• Type: string

count

Future week count.

Note: 4.

• Required: No
• Type: number

format

Date format.

Note: YYYY.MM.DD.

• Required: No
• Type: string

Output

milestones

If any milestones were created, this will contain an array of their URLs.

Example

name: Weekly Milestones

on:
  schedule:
    - cron: 0 0 * * SUN # Run every Sunday at midnight

jobs:
  generate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2

      - name: Schedule Milestones
        uses: readmeio/scheduled-milestones@v1
        id: scheduled
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          title: Up for Review
          days: Tuesday,Thursday
          date_options: {"month": "long", "day": "numeric"}

      - name: Created Milestones
        run: echo ${{ steps.scheduled.outputs.milestones }}

name: auto-create-milestone

on:
  schedule:
    - cron: 0 0 * * SAT

jobs:
  generate:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2

      - uses: readmeio/scheduled-milestones@v1.1
        id: run
        with:
          token: ${{ secrets.GITHUB_TOKEN }}
          title: d-
          days: Friday
          count: 4
          format: YYYY.MM.DD

      - name: result
        run: echo ${{ steps.run.outputs.milestones }}