GitHub/Workflow - Revision history

Kenneth: /* Starter Workflows */

2023-12-25T01:41:58Z

Starter Workflows

Kenneth: /* Manual Run */

2023-12-25T01:19:01Z

Manual Run

Kenneth: /* Remotely Trigger Workflow - repository_dispatch */

2023-12-25T01:18:02Z

Remotely Trigger Workflow - repository_dispatch

Kenneth: /* Remotely Trigger Workflow - repository_dispatch */

2023-12-25T00:35:03Z

Remotely Trigger Workflow - repository_dispatch

Kenneth: /* Dynamic Jobs */

2023-12-25T00:24:59Z

Dynamic Jobs

Kenneth: /* Dynamic Jobs */

2023-12-24T00:10:25Z

Dynamic Jobs

Kenneth: /* Basic Workflow */

2023-09-09T04:46:37Z

Basic Workflow

New page

== Manual Run ==

manual.yaml:
<pre>
name: Manual Run
run-name: Test
on:
workflow_dispatch:
inputs:
LABEL:
required: true
type: string
description: label

jobs:
run:
runs-on: ${{ inputs.LABEL }}
steps:
- run: hostname
</pre>

== Basic Workflow ==

<pre>
name: GitHub Actions Demo
run-name: ${{ github.actor }} is testing out GitHub Actions 🚀
on: [push]
jobs:
Explore-GitHub-Actions:
runs-on: ubuntu-latest
steps:
- run: echo "🎉 The job was automatically triggered by a ${{ github.event_name }} event."
- run: echo "🐧 This job is now running on a ${{ runner.os }} server hosted by GitHub!"
- run: echo "🔎 The name of your branch is ${{ github.ref }} and your repository is ${{ github.repository }}."
- name: Check out repository code
uses: actions/checkout@v3
- run: echo "💡 The ${{ github.repository }} repository has been cloned to the runner."
- run: echo "🖥️ The workflow is now ready to test your code on the runner."
- name: List files in the repository
run: |
ls ${{ github.workspace }}
- run: echo "🍏 This job's status is ${{ job.status }}."
</pre>

ref: https://docs.github.com/en/actions/quickstart

== Using Job Output ==

<pre>
jobs:
job1:
runs-on: ubuntu-latest
# Map a step output to a job output
outputs:
output1: ${{ steps.step1.outputs.test }}
output2: ${{ steps.step2.outputs.test }}
steps:
- id: step1
run: echo "test=hello" >> "$GITHUB_OUTPUT"
- id: step2
run: echo "test=world" >> "$GITHUB_OUTPUT"
job2:
runs-on: ubuntu-latest
needs: job1
steps:
- env:
OUTPUT1: ${{needs.job1.outputs.output1}}
OUTPUT2: ${{needs.job1.outputs.output2}}
run: echo "$OUTPUT1 $OUTPUT2"
</pre>

ref: Defining outputs for jobs - GitHub Enterprise Cloud Docs - https://docs.github.com/en/enterprise-cloud@latest/actions/using-jobs/defining-outputs-for-jobs

== Dynamic Runs-on ==

Dynamic from Input:
<pre>
name: Dynamic Labels
run-name: Dynamic Labels
on:
workflow_dispatch:
inputs:
LABELS:
required: false
type: string

jobs:
run:
# runs-on: ${{ fromJSON( '["CI"]' ) }} # This works
# runs-on: ${{ fromJSON( '["CI", "MORE"]' ) }} # This works
runs-on: ${{ fromJSON( inputs.LABELS ) }} # This works if formatted like: ["CI", "MORE"]
# runs-on: ${{ inputs.LABELS }} # this works for single label
# runs-on: [ CI, MORE ] # this works
steps:
- run: hostname
</pre>

Dynamic from script:
<pre>
name: Dynamic Script
run-name: Test
on:
workflow_dispatch:
inputs:
Go:
required: false
type: string

jobs:
job1:
runs-on: ubuntu-latest
outputs:
RUNS: ${{ steps.set-RUNS.outputs.RUNS }}
steps:
- id: set-RUNS
run: echo "RUNS=[\"CI\",\"MORE\"]" >> $GITHUB_OUTPUT
job2:
needs: job1
runs-on: ${{fromJSON(needs.job1.outputs.RUNS)}}
steps:
- run: hostname
</pre>

ref:
* How to Dynamically assign the runs-on value in the github actions - Stack Overflow - https://stackoverflow.com/questions/73241812/how-to-dynamically-assign-the-runs-on-value-in-the-github-actions
* Github Actions: How use strategy/matrix with script - Stack Overflow - https://stackoverflow.com/questions/59977364/github-actions-how-use-strategy-matrix-with-script

== Dynamic Jobs ==

<pre>
name: Dynamic Jobs
run-name: Test
on:
workflow_dispatch:
inputs:
Go:
required: false
type: string

jobs:
generate:
runs-on: ubuntu-latest
outputs:
MATRIX: ${{ steps.set-MATRIX.outputs.MATRIX }}
steps:
- id: set-MATRIX
run: echo "MATRIX={\"include\":[{\"runson\":[\"CI\",\"MORE\"],\"task\":\"joe\"},{\"runson\":[\"CI\",\"LESS\"],\"task\":\"bob\"}]}" >> $GITHUB_OUTPUT
jober:
needs: job1
runs-on: ${{ matrix.runson }}
strategy:
matrix: ${{fromJson(needs.generate.outputs.matrix)}}
steps:
- run: hostname
- run: echo ${{ matrix.runson }}
- run: echo ${{ matrix.task }}
</pre>

== keywords ==

@@ Line 6: / Line 6: @@
   actions/starter-workflows: Accelerating new GitHub Actions workflows
   https://github.com/actions/starter-workflows
 == Manual Run ==

← Older revision		Revision as of 01:19, 25 December 2023
Line 1:		Line 1:
		+	== Starter Workflows ==
		+
		+	Quickstart for GitHub Actions - GitHub Docs
		+	https://docs.github.com/en/actions/quickstart
		+
		+	actions/starter-workflows: Accelerating new GitHub Actions workflows
		+	https://github.com/actions/starter-workflows
		+
	== Manual Run ==		== Manual Run ==

@@ Line 164: / Line 164: @@
    repository_dispatch:
 </pre>
   curl -X POST https://api.github.com/repos/ORG/REPO/dispatches -d '{"event_type":"some_event_type"}'
    #  -d or --data, -X or --request
    #  -H "Accept: application/vnd.github+json"
    # You will most likely need to also pass along auth: (unless you are silly and on a publicly executable workflow?)
    # -H "Authorization: Bearer $GITHUB_TOKEN"
   if you want to trigger from some other branch:
    {...,'ref':'other_branch_or_ref'},...}
- if you want to pass in inputs:
+---
   repository_dispatch - Events that trigger workflows - GitHub Docs
   https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#repository_dispatch
 ---

← Older revision		Revision as of 00:35, 25 December 2023
Line 171:		Line 171:
	# -H "Authorization: Bearer $GITHUB_TOKEN"		# -H "Authorization: Bearer $GITHUB_TOKEN"

		+	if you want to trigger from some other branch:
		+	{...,'ref':'other_branch_or_ref'},...}
		+
		+	if you want to pass in inputs:
		+	{...,'inputs':{'input1':'val1',...},...}

	repository_dispatch - Events that trigger workflows - GitHub Docs		repository_dispatch - Events that trigger workflows - GitHub Docs

@@ Line 156: / Line 156: @@
      - run: echo ${{ matrix.runson }}
      - run: echo ${{ matrix.task }}
 </pre>
 == keywords ==

@@ Line 148: / Line 148: @@
        run: echo "MATRIX={\"include\":[{\"runson\":[\"CI\",\"MORE\"],\"task\":\"joe\"},{\"runson\":[\"CI\",\"LESS\"],\"task\":\"bob\"}]}" >> $GITHUB_OUTPUT
    jober:
-     needs: job1
+     needs: generate
      runs-on: ${{ matrix.runson }}
      strategy: