Run github workflow with python

Question

I have a python workflow in github here. I can run that workflow from the web interface. But problem is everytime I have to visit github and click on run workflow. Again I have to login in github from an unknown device to run that workflow. Is there any github module in python that can run a workflow using a personal access token? Or how can I run a workflow with github api using requests module? I searched about this topic on google but I didn’t found any solution that works. Many of those are out dated or not explained properly.

This is the workflow I used here:

name: Python
on:
  workflow_dispatch:
  
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - name: checkout repo
        uses: actions/[email protected]
      - name: Run a script
        run: python3 main.py

I'd check out Github's docs on events that can trigger individual workflows. This can be pull requests, pushes to a main branch, etc — C.Nivs
– C.Nivs, Commented Oct 17, 2022 at 17:16
I've never worked with github api... Soo can you help me to find that api🙂 — Shahriar Zarir
– Shahriar Zarir, Commented Oct 17, 2022 at 17:26
You can find the relevant docs following the link that @C.Nivs posted, but to save you a few clicks, here. — larsks
– larsks, Commented Oct 17, 2022 at 17:52

Shahriar Zarir · Accepted Answer · 2022-10-18 03:06:11Z

Thanks to @C.Nivs & @larsks for helping me to find the right documentation. After experimenting with github api, finally I found my answer. Here is the code I used:

branch, owner, repo, workflow_name, ghp_token="main", "dev-zarir", "Python-Workflow", "python.yml", "ghp_..."

import requests

def run_workflow(branch, owner, repo, workflow_name, ghp_token):
    url = f"https://api.github.com/repos/{owner}/{repo}/actions/workflows/{workflow_name}/dispatches"
    
    headers = {
        "Accept": "application/vnd.github+json",
        "Authorization": f"Bearer {ghp_token}",
        "Content-Type": "application/json"
    }

    data = '{"ref":"'+branch+'"}'
    
    resp = requests.post(url, headers=headers, data=data)
    return resp
    
response=run_workflow(branch, owner, repo, workflow_name, ghp_token)

if response.status_code==204:
    print("Workflow Triggered!")
else:
    print("Something went wrong.")

nicolas.f.g · Accepted Answer · 2024-03-20 15:01:06Z

0

A more pythonic solution would be to use the pygithub package:

import github, os
g = github.Github(login_or_token=os.environ["GITHUB_PAT"])

repo = g.get_repo("my_org/my_repo")

workflow_name = "cicd.yml"
workflow = repo.get_workflow(workflow_name)

ref = repo.get_branch("develop")
workflow.create_dispatch(ref=ref)

See https://pygithub.readthedocs.io/en/latest/github_objects/Workflow.html

answered Mar 20, 2024 at 15:01

nicolas.f.g

1,26111 silver badges14 bronze badges

1 Comment

Light Over a year ago

This only creates the run which may be blocked by approval gates. There is currently no option in the SDK for creating a review to approve a workflow run like there is in the gh api cli.

Collectives™ on Stack Overflow

Run github workflow with python

2 Answers 2

Comments

1 Comment

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

Comments

1 Comment

Related