This GitHub Action will calculate a set of DevOps Research and Assessment (DORA) metrics based on status and dates from commits and issues.
Repository from where to read issues and statuses. List one or more repositories, either as one single string, as an array or all separated by newlines. Valid formats are:
repo: my-repo
repo: [my-repo, my-other-repo]
repo:
my-repo
my-other-repo
Default repo value is repo where action is installed if no repos are spefied.
Owner of the repository. Default is current repository owner or organisation. Only one is handled.
Access token for the repository.
Set to true to make event logs of metrics source avaiable.
Set to true to filter pulls to only include feat and fix as basis for the lead time metric
Rate of deploys (tagged releases) per week. Decimal number. Elite performing teams has 7 as target (daily- or on-demand release)
deploy-frequency-log
- a list of releases forming the basis for the metric, if logging
is enabled.
Time from issue is set to status doing until linked pull-requestis merged to main branch. Number in days (Integer)
lead-time-log
- a list of pull requests with matching first commit and re forming the basis for the metric, if logging
is enabled.
Number of registered issues tagged as bugs divided by number of release tags last month.
By counting the bugs (github issues tagged as bug
) between releases the last month and average this, we get the failures over releases rate.
Number in range 0 - 100 (%)
Mean time to restore. This metric is calculated based on the time between the last release before an issue tagged as a bug and the first release after the bug is closed. For this to work correctly we must assume github issues are created for all unwanted issues in production and that all changes to production is done through releases. Number in hours (integer)
Simplest possible use of this action is something like this:
name: Calculate DevOps Metrics
on:
schedule:
- cron: '30 0 * * *'
jobs:
update-metrics:
runs-on: ubuntu-latest
name: Checking the dora metrics
steps:
- name: DevOps Metrics from GitHub
uses: stenjo/devops-metrics-action@v1
id: dora
with:
token: ${{ secrets.GITHUB_TOKEN }}
This will base calculations on the repo where the workflow is installed and run 12:30 AM every day.
To access the outputs anywhere in the workflow, refer to the output of the calculation step via variable format ${{ steps.dora.outputs.deploy-rate }}
. Something like:
- name: Get the output rate
run: echo "The deploy rate was ${{ steps.dora.outputs.deploy-rate }}" # Use the output from the `dora` step
More complex examples may be found in .github/workflows/badges.yaml and .github/workflows/dora.yaml
Badges at the top of this file is generated through the badges.yaml workflow. More on this in Create badges for metrics output