Skip to content

milestone estimate tracking

Jump to bottom
Ben Elan edited this page Oct 2, 2024 · 2 revisions

tags: [ci, triage]

Milestone Estimate Tracking

Calcite uses estimate labels to predict how much time an issue will take, which improves the accuracy of milestone planning. The track-milestone-estimates.yml workflow compiles the total estimates per milestone for analysis.

Usage

GitHub CLI

Use the following gh commands to dispatch the workflow and download the artifacts. You can copy and paste the full code block into your terminal:

# run the workflow and give GitHub some time to process the request
gh workflow run track-milestone-estimates.yml && sleep 5

# get the id of the workflow's most recent run
__run_id="$(
    gh run list --workflow=track-milestone-estimates.yml \
        --json=databaseId --jq='.[].databaseId' --limit=1
)"

# watch the run and download the artifact if it succeeds
gh run watch --exit-status $__run_id && gh run download $__run_id

The data is saved to the current working directory in both CSV and JSON format.

open ./milestone-estimates/milestone-estimates.csv

GitHub Website

Use the following steps to manually run the workflow and download the run's artifact:

  1. Go to the workflow's page
  2. Open the run workflow dropdown on the right side of the screen
  3. Click the Run workflow button (keep the default branch)
  4. Wait for the run to appear at the top of the list (it may take a few seconds after clicking the button)
  5. Click the Track Milestone Estimates title of the first run on the list
  6. Wait for the run to complete. An Artifacts section will appear at the bottom of the page (if not, refresh)
  7. Click the download button on the right of the milestone-estimates artifact
  8. Extract the milestone-estimates.zip file in your Downloads directory
  9. Open the data, which is provided in both CSV (spreadsheet) and JSON format

Use the latest workflow run

The workflow will run automatically when an issue is closed. This means you can skip dispatching the workflow and download the artifact from the latest run.

  • Website users can skip numbers 2-4,6 in the steps above.

  • CLI users can run this command instead of the ones above:

    # you can uncomment the --status flag on failure, but the data may be outdated
gh run download "$(
    gh run list --workflow=track-milestone-estimates.yml \
        --json=databaseId --jq='.[].databaseId' --limit=1 # --status=success
)"

Home

Tokens

Clone this wiki locally