GitHub Action to get the current workflow run's job_id
This GitHub Action depends on the GitHub REST API Version: 2022-11-28.
https://docs.github.com/ja/rest/actions/workflow-jobs?apiVersion=2022-11-28
Required GITHUB_TOKEN to use GitHub API
Simply, just specify ${{ secrets.GITHUB_TOKEN }}.
Required jobs.<job-id>.name of tartget workflow jobs
If no name specified, use jobs.<job-id> instead. Note that <job-id> != job_id.
If you are using this actions with matrix workflow, check the example section.
jobs:
my_first_job: # this is jobs.<job-id>
name: My first job # this is jobs.<job-id>.name
my_second_job: # this is jobs.<job-id>
name: My second job # this is jobs.<job-id>.namejobs.<job-id>: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idjobs.<job-id>.name: https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idname
target GitHub repository
default: ${GITHUB_REPOSITORY}
run_id of target workflow run
default: ${GITHUB_RUN_ID}
Results per page (max 100) of target workflow run
default: 30
If there are more than 30 jobs for the target workflow, set this parameter.
job_id of target workflow jobs
html_url of target workflow jobs
The job using this GitHub Actions must have the actions:read permission.
name: CI
on:
push:
permissions:
actions: read
contents: read # required by actions/checkout
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout action
uses: actions/checkout@v4
- name: Some Scripts
run: echo "do something here"
- name: Get Current Job Log URL
uses: Tiryoh/gha-jobid-action@v1
id: jobs
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
job_name: "build" # input job.<job-id>
#job_name: "${{ github.job }}" # if job.<job-id>.name is not specified, this works too
- name: Output Current Job Log URL
run: echo ${{ steps.jobs.outputs.html_url }}name: CI
on:
push:
permissions:
actions: read
contents: read # required by actions/checkout
jobs:
build:
name: Build and Test
runs-on: ubuntu-latest
steps:
- name: Checkout action
uses: actions/checkout@v4
- name: Some Scripts
run: echo "do something here"
- name: Get Current Job Log URL
uses: Tiryoh/gha-jobid-action@v1
id: jobs
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
job_name: "Build and Test" # input job.<job-id>.name here. job.<job-id> won't works.
- name: Output Current Job Log URL
run: echo ${{ steps.jobs.outputs.html_url }}name: CI
on:
push:
permissions:
actions: read
contents: read # required by actions/checkout
jobs:
build:
strategy:
matrix:
distro: [alpha, beta, gamma]
runs-on: ubuntu-latest
steps:
- name: Checkout action
uses: actions/checkout@v4
- name: Some Scripts
run: echo "do something here ${{ matrix.distro }}"
- name: Get Current Job Log URL
uses: Tiryoh/gha-jobid-action@v1
id: jobs
with:
github_token: ${{ secrets.GITHUB_TOKEN }}
job_name: "build (${{ matrix.distro }})" # input job.<job-id>.name and matrix here.
per_page: 50 # input matrix size here if it is larger than 30
- name: Output Current Job Log URL
run: echo ${{ steps.jobs.outputs.html_url }}- Get current
job_idURL - Output
job_idURL
Special Thanks
- @IngoStrauch2020
- Petr Pučil (@generalmimon)
- Masaya Suzuki (@massongit)
- phoeniixdotcom
- Florian Kaiser
Contributions are always welcome!
Copyright (c) 2020-2024 Daisuke Sato
This repository is licensed under the MIT License, see LICENSE.
Unless attributed otherwise, everything in this repository is licensed under the MIT license.