|
| 1 | +--- |
| 2 | +title: Triggering GitHub Actions |
| 3 | +lang: en |
| 4 | +layout: post |
| 5 | +audio: false |
| 6 | +translated: false |
| 7 | +generated: true |
| 8 | +--- |
| 9 | + |
| 10 | +Yes, a GitHub Action can trigger another GitHub Action, though not directly. GitHub Actions workflows are typically triggered by specific events like pushes, pull requests, or schedules, but there are several indirect methods to make one workflow trigger another. Below are the primary ways this can be achieved: |
| 11 | + |
| 12 | +--- |
| 13 | + |
| 14 | +### 1. Using the `workflow_dispatch` Event |
| 15 | +You can trigger a workflow programmatically using the `workflow_dispatch` event via the GitHub API. This allows one workflow to initiate another that is configured to listen for this event. |
| 16 | + |
| 17 | +- **How it works**: The first workflow makes an API call to trigger the second workflow. |
| 18 | +- **Example**: |
| 19 | + ```yaml |
| 20 | + name: Trigger Another Workflow |
| 21 | + on: [push] |
| 22 | + jobs: |
| 23 | + trigger: |
| 24 | + runs-on: ubuntu-latest |
| 25 | + steps: |
| 26 | + - name: Trigger Workflow |
| 27 | + run: | |
| 28 | + curl -X POST \ |
| 29 | + -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \ |
| 30 | + -H "Accept: application/vnd.github.v3+json" \ |
| 31 | + https://api.github.com/repos/<owner>/<repo>/actions/workflows/<workflow_id>/dispatches \ |
| 32 | + -d '{"ref": "main"}' |
| 33 | + ``` |
| 34 | + Replace `<owner>`, `<repo>`, and `<workflow_id>` with your repository details and the target workflow's ID. The second workflow must include `on: [workflow_dispatch]` in its configuration. |
| 35 | + |
| 36 | +--- |
| 37 | + |
| 38 | +### 2. Using Repository Dispatch Events |
| 39 | +A workflow can send a custom event using a repository dispatch, which another workflow can listen for and trigger on. |
| 40 | + |
| 41 | +- **How it works**: The first workflow sends a repository dispatch event via the GitHub API, and the second workflow responds to that event. |
| 42 | +- **Example**: |
| 43 | + - First workflow (sends the event): |
| 44 | + ```yaml |
| 45 | + name: Send Dispatch Event |
| 46 | + on: [push] |
| 47 | + jobs: |
| 48 | + send-dispatch: |
| 49 | + runs-on: ubuntu-latest |
| 50 | + steps: |
| 51 | + - name: Send Dispatch |
| 52 | + run: | |
| 53 | + curl -X POST \ |
| 54 | + -H "Authorization: token ${{ secrets.GITHUB_TOKEN }}" \ |
| 55 | + -H "Accept: application/vnd.github.v3+json" \ |
| 56 | + https://api.github.com/repos/<owner>/<repo>/dispatches \ |
| 57 | + -d '{"event_type": "custom_event"}' |
| 58 | + ``` |
| 59 | + - Second workflow (triggered by the event): |
| 60 | + ```yaml |
| 61 | + name: Triggered by Dispatch |
| 62 | + on: |
| 63 | + repository_dispatch: |
| 64 | + types: [custom_event] |
| 65 | + jobs: |
| 66 | + respond: |
| 67 | + runs-on: ubuntu-latest |
| 68 | + steps: |
| 69 | + - name: Respond to Event |
| 70 | + run: echo "Triggered by custom_event" |
| 71 | + ``` |
| 72 | + |
| 73 | +--- |
| 74 | + |
| 75 | +### 3. Triggering via Git Events |
| 76 | +One workflow can trigger another by generating a Git event, such as creating a commit or opening a pull request, which the second workflow is set to respond to. |
| 77 | + |
| 78 | +- **How it works**: The first workflow modifies the repository (e.g., by pushing a commit), triggering a second workflow configured for that event (e.g., `on: [push]`). |
| 79 | +- **Example**: |
| 80 | + ```yaml |
| 81 | + name: Create Commit |
| 82 | + on: [push] |
| 83 | + jobs: |
| 84 | + create-commit: |
| 85 | + runs-on: ubuntu-latest |
| 86 | + steps: |
| 87 | + - name: Checkout |
| 88 | + uses: actions/checkout@v2 |
| 89 | + - name: Create File |
| 90 | + run: echo "New file" > newfile.txt |
| 91 | + - name: Commit and Push |
| 92 | + run: | |
| 93 | + git config user.name "GitHub Action" |
| 94 | + git config user.email "[email protected]" |
| 95 | + git add newfile.txt |
| 96 | + git commit -m "Add new file" |
| 97 | + git push |
| 98 | + ``` |
| 99 | + This could trigger another workflow set to run on `push` events. |
| 100 | + |
| 101 | +--- |
| 102 | + |
| 103 | +### Key Considerations |
| 104 | +- **Permissions**: The GitHub token used in API calls must have sufficient permissions to trigger workflows or send dispatch events. |
| 105 | +- **Rate Limits**: Be aware of GitHub's API rate limits, especially for frequently running workflows. |
| 106 | +- **Avoid Loops**: Prevent infinite loops by adding conditions to stop workflows from endlessly triggering each other. |
| 107 | +- **Configuration**: Ensure the target workflow is correctly set up to listen for the intended event. |
| 108 | + |
| 109 | +--- |
| 110 | + |
| 111 | +### Conclusion |
| 112 | +While GitHub Actions doesn’t offer a direct mechanism for one workflow to call another, you can achieve this indirectly using `workflow_dispatch`, repository dispatch events, or Git events like commits or pull requests. These methods allow you to chain or trigger workflows effectively based on your needs. |
0 commit comments