GitHub Action
GitHub Workflow Duration Calculator
v0.2.4
Latest version
This GitHub Action calculates the total time taken from the start of the workflow to a specified step. The calculated duration can be used to notify different providers, such as Slack and WhatsApp, to help developers and clients improve their actions or codebase.
- Notify team members about the workflow duration.
- Monitor and optimize workflow performance.
- Provide insights into workflow efficiency.
| Parameter | Required/Optional | Description |
|---|---|---|
GITHUB_TOKEN |
Required | This token is provided by GitHub. Use ${{secrets.GITHUB_TOKEN}}. |
id |
Required | A unique identifier for the duration calculation. For example, use duration. |
Create a file named workflow.yml in the .github/workflows folder.
name: The name of your workflow
on: [push]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Calculate Steps Log Time
id: duration
uses: RockyIsHere/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Print Calculated Time
run: |
echo "Calculated Time: ${{ steps.duration.outputs.duration }}"This example demonstrates a complete workflow that calculates the duration and prints it:
name: CI Pipeline
on: [push]
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- name: Checkout code
uses: actions/checkout@v2
- name: Setup Node.js
uses: actions/setup-node@v2
with:
node-version: '14'
- name: Install dependencies
run: npm install
- name: Run tests
run: npm test
- name: Calculate Steps Log Time
id: duration
uses: RockyIsHere/[email protected]
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Print Calculated Time
run: |
echo "Calculated Time: ${{ steps.duration.outputs.duration }}"In this example, the workflow performs the following steps:
- Checks out the code.
- Sets up Node.js.
- Installs dependencies.
- Runs tests.
- Calculates the time taken for the steps.
- Prints the calculated time.
This setup helps in monitoring the workflow duration and can be integrated with notification systems for better visibility and performance tracking.