Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guillaumefalourd/poc-github-actions
Various proofs of concept examples using Github Actions 🤖
https://github.com/guillaumefalourd/poc-github-actions
beginners examples github-actions poc proof-of-concept workflows
Last synced: 7 days ago
JSON representation
Various proofs of concept examples using Github Actions 🤖
- Host: GitHub
- URL: https://github.com/guillaumefalourd/poc-github-actions
- Owner: GuillaumeFalourd
- License: apache-2.0
- Created: 2021-03-26T18:31:28.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-10-30T04:17:51.000Z (about 2 months ago)
- Last Synced: 2024-10-30T05:09:47.941Z (about 2 months ago)
- Topics: beginners, examples, github-actions, poc, proof-of-concept, workflows
- Language: Python
- Homepage:
- Size: 4.14 MB
- Stars: 294
- Watchers: 6
- Forks: 101
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# poc-github-actions
This repository contains various proofs of concept using a Github Actions through workflows 🤖
## Contents 🇧🇷
- [Introdução ao Github Actions](https://www.zup.com.br/blog/github-actions-ci-cd)
- [Como executar um script usando GitHub Actions](https://www.zup.com.br/blog/executar-script-github-actions)
- [Github Actions – variáveis de ambiente e secrets](https://www.zup.com.br/blog/github-actions-variaveis-de-ambiente-e-secrets)
- [Como manipular outputs no GitHub Actions](https://www.zup.com.br/blog/manipular-outputs-github-actions)
- [Workflows no GitHub Actions: como usar events e triggers](https://www.zup.com.br/blog/workflows-no-github-actions)
- [Como manipular outputs no GitHub Actions](https://www.zup.com.br/blog/manipular-outputs-github-actions)
- [Como usar imagens do Docker com workflows no Github Actions](https://www.zup.com.br/blog/github-actions-docker)
- [Como gerenciar artefatos nos workflows do Github Actions](https://www.zup.com.br/blog/artefatos-github-actions)
- [Como usar condicionais nos workflows do Github Actions ](https://www.zup.com.br/blog/como-usar-condicionais-workflows-github-actions)
- [10 boas práticas e dicas para usar o GitHub Actions](https://www.zup.com.br/blog/github-actions-dicas-boas-praticas)
- [Quando usar Reusable Workflow ou Composite Action no GitHub Actions?](https://www.zup.com.br/blog/reusable-workflow-e-composite-action)
- [Git Flow customizado no Github Actions](https://www.zup.com.br/blog/git-flow)
## Workflow YAML Basic Structure Explanation
```bash
name: Github action workflow name
on:
push: # Run this workflow every time a new commit pushed to the repository
pull_request: # Run this workflow every time a new pull request is opened to the repository
scheduled: # Run this workflow as a cron job
- cron: "0 0 * * MON-FRI"
workflow_dispatch: # Run this workflow on demand (manually)
jobs: # All workflows need at list one job
job-key: #First job
name: Job Name
runs-on: ubuntu-latest # Set the type of machine the workflow will run on
steps: # Each job can be divided in many steps
- name: Checkout code # Step name
uses: actions/checkout@v2 # Action used on the step
- name: Run Super-Linter # Another step name
uses: github/super-linter@v3 # Action used on the step
env: # Environment variables used on the step
DEFAULT_BRANCH: main
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
- name: Run specific commands # Another step name
run: |
ls -lha
echo "This is a shell command"
```
## Examples
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/01-default-workflow.yml)
This workflow uses [CRON](https://crontab.guru/#*_*_*_*_*) to run some basic commands.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/02-secret-workflow.yml)
This workflow uses [CRON](https://crontab.guru/#*_*_*_*_*) to run some basic commands using repository secrets.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/03-python-script-workflow.yml)
This workflow uses [CRON](https://crontab.guru/#*_*_*_*_*) to execute a specific script [run.py](https://github.com/GuillaumeFalourd/poc-github-actions/blob/main/run.py) located on the repository.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/04-dispatch-event-workflow.yml)
This workflow uses [CRON](https://crontab.guru/#*_*_*_*_*) to dispatch an event to the [ritchie-formulas-scheduler-demo repository](https://github.com/GuillaumeFalourd/ritchie-formulas-scheduler-demo).
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/05-container-workflow.yml)
This workflow uses [CRON](https://crontab.guru/#*_*_*_*_*) with a docker container where Ritchie CLI and Golang are installed, then check Ritchie CLI and Golang versions through commands.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/06-docker-image-workflow.yml)
This workflow uses [CRON](https://crontab.guru/#*_*_*_*_*) and a docker image `foundeo/minibox:latest`. It also specify an `entrypoint` (the command to run inside the container) and `args` (command line arguments to pass to the command specified in entrypoint). It is possible to omit the `entrypoint` if the container already species the entrypoint you want to use.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/07-action-workflow.yml)
This workflow will run an Action each time a `PUSH` event occurs on the repository. This specific action runs a Ritchie CLI formula.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/08-outputs-workflow.yml)
This workflow illustrates how to set outputs in a job to use them on another job. This specific workflow prints `Hello-World`.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/09-artifacts-workflow.yml)
This workflow illustrates how to pass data between jobs in the same workflow. For more information, see the [actions/upload-artifact](https://github.com/actions/upload-artifact) and [download-artifact](https://github.com/actions/download-artifact) actions. The full math operation performed in this workflow example is `(3 + 7) x 9 = 90`.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/10-environment-workflow.yml)
This workflow illustrates how to use `environment` variables from the whole workflow, a specific job, or a specific step, as well as for an environment secret.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/11-input-workflow.yml)
This workflow illustrates how to use `input` variables on a `workflow_dispatch` event.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/12-run-workflow.yml)
This workflow illustrates how to run a workflow once another specific one has been completed (with success or failure).
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/13-create-pull-request.yml)
This workflow uses [CRON](https://crontab.guru/#*_*_*_*_*) to automatically create a Pull Request committing updated files.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/14-auto-merge.yml)
This workflow illustrates how to automatically merge a Pull Request with a specific label `automerge`.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/15-push-dev.yml)
This workflow only run when a push is made to the `dev` branch.
Note that with this implementation, the workflow needs to be present on the specific branch as well (here `dev`).
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/16-conditional.yml)
This workflow illustrates how to use conditional through the `if` variable.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/17-issue-greeter.yml)
This workflow illustrates how to write an automatic comment on a new issue, without using action, through the github API.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/18-specific-file.yml)
This workflow illustrates how to trigger a workflow when specific files are updated by a `push` or `pull_request` event.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/19-push-event.yml)
This workflow illustrates how use the [checkout action](https://github.com/actions/checkout) to create a push event, updating a file and committing it to the branch.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/20-generate-patch-tag-cherry-pick.yml)
This workflow illustrates how use cherry-pick to generate a new repository tag informing 3 inputs (`reference tag`, `new tag`, and `commit hash`).
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/21-generate-release-branch-cherry-pick.yml)
This workflow illustrates how use cherry-pick to generate a new release branch informing 3 inputs (`reference tag`, `new tag`, and `commit hash`).
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/22-install-runner-tools.yml)
This workflow illustrates how to install tools not supported by the ubuntu runner using `apt-get install`.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/23-upload-release-asset.yml)
This workflow illustrates how to upload a release asset. [Example]( https://github.com/GuillaumeFalourd/poc-github-actions/releases/tag/821d0256)
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/24-contexts.yml)
This workflow illustrates how to access various context variables on a workflow.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/25-artifacts-between-workflows-1.yml) [](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/25-artifacts-between-workflows-2.yml)
These workflows illustrate how to share datas between various workflows using artifacts.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/26-create-release-branch-other-repo.yml)
This workflow illustrates how to create a new branch on another repository based on the current repository tag.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/27-check-tags.yml)
This workflow illustrates how to use outputs between jobs with the `needs` context to check tags and manage them to perfom some operation according to their name.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/28-create-pull-request.yml)
This workflow illustrates how to create a new Pull Request based on a branch name after a push event.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/29-check-actor-pr-or-push.yml)
This workflow illustrates how to add a comment on a new Pull Request based on the github actor name after a PR event.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/30-webhook-release.yml) - DEPRECATED
This workflow illustrates how to call a webhook on each release extracting the release tag.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/31-untouchable-file.yml)
This workflow illustrates how to close a Pull Request automatically if it updates on file that shouldn't be modified.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/32-pr-approved-and-labeled.yml)
This workflow illustrates how to perform a specific action when approving a Pull request if it contains a specific label.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/33-reusable-workflow.yml)
This workflow illustrates how to implement a [reusable workflow](https://docs.github.com/en/actions/learn-github-actions/reusing-workflows).
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/34-workflow-call.yml)
This workflow illustrates how to use and call a reusable workflow (cf workflow 33 above).
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/35-github-config.yml)
This workflow illustrates how to extract and use the user email and username from the commit using github config log commands.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/36-local-action.yml)
This workflow illustrates how to use a `local action` file in one (or multiple workflows) and extract its outputs to perform other operations.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/37-continue-on-error-matrix.yml)
This workflow illustrates how to use matrix as well as expressions with `continue-on-error` and `if` conditionnal fields.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/38-get-pr-number-on-push-event.yml)
This workflow illustrates how to get the related PR number to a push event.
[PR event](https://github.com/GuillaumeFalourd/poc-github-actions/runs/4317001308?check_suite_focus=true) and [Related PUSH event](https://github.com/GuillaumeFalourd/poc-github-actions/runs/4317001027?check_suite_focus=true)
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/39-extract-from-branch.yml) [](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/40-invoked-workflow-dispatch.yml)
This workflows illustrate how to extract the tag version when a specific branch is created (e.g: `release-1.2.3`), and how to invoke another workflow through a disptach event sending this tag as input.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/41-commit-other-repo.yml)
This workflow illustrates how to commit files from the current repo to another repo.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/43-not-trigger-on-tag.yml)
This workflow illustrates how to trigger a workflow on different event but NOT on tag.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/44-check-if-pr-from-fork.yml)
This workflow illustrates how to check if a PR is opened from a FORK repository or not.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/45-get-all-yaml-files.yml)
This workflow illustrates how to list all files from a specific extension (here, `.yaml` or `.yml`).
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/46-print-env.yml)
This workflow illustrates how to list all env variables set in the runner.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/47-force-failure.yml) - AS EXPECTED
This workflow illustrates how to force a workflow failure if a condition isn't met.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/48-wait-for-reusable-completion.yml) - DEPRECATED
This workflow illustrates how to wait for other workflows completion before executing some operation (using reusable workflows).
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/49-rename-on-release.yml)
This workflow illustrates how to rename a file according to the `github ref name` (branch or tag name).
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/50-create-tag.yml)
This workflow illustrates how to simply create a tag in a job.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/51-concurrency.yml)
This workflow illustrates how to use concurrency to avoid the same workflow to run in parallel for different push to the same branch (for example to limit Github actions runner usage in private repo).
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/52-print-secret.yml)
This workflow illustrates how to print secrets values on a workflow run. To harden the security of your github actions, have a look at [this guide](https://docs.github.com/en/actions/security-guides/security-hardening-for-github-actions) on the Github Official Documentation.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/53-concatenation.yml)
This workflow illustrates how to concatenate `env` variables using the environment file.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/54-permission.yml)
This workflow illustrates how to use the `permission` field at the workflow level. Giving the GITHUB_TOKEN a specific permission scope during the workflow execution.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/55-create-issue.yml) [](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/55-read-issue.yml)
These workflows illustrate how to **create** and **read** an issue body variable according to a specific [issue template](https://github.com/GuillaumeFalourd/poc-github-actions/blob/main/.github/ISSUE_TEMPLATE_DEPLOYMENT.md).
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/57-reusable-outputs.yml)
This workflow illustrates how to use **outputs** with reusable workflows.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/58-env-expressions.yml)
This workflows illustrates how to use **expressions** when setting env variables ath the workflow level, according to the trigger event.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/59-step-context.yml)
This workflows illustrates how to use **[step context](https://docs.github.com/en/actions/learn-github-actions/contexts#steps-context)**, which contains detail about the execution of each step by default. Using the `outcome` property of each step we can check the result of its execution.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/60-save-secrets-variables.yml)
This workflow illustrates how to save secrets in artifacts to use on later jobs.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/61-create-tag-and-release.yml) [](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/62-trigger-on-release-other-workflow.yml)
Those workflows illustrate how to **trigger a release creation** (with tag based on a branch syntax) where the release publication could **trigger a deployment pipeline**.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/63-matrix-folder.yml)
This workflow illustrates how to identify updated folders to perfom a similar behavior based on the folder through a reusable workflow with a matrix strategy.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/65-sequential-matrix.yml)
This workflow illustrates how to execute sequencial jobs in specific order using matrix with `max-parallel: 1` strategy.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/66-matrix-object.yaml)
This workflow illustrates how to manipulate matrix object to perform different operation according to a object type.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/67-fromjson-env-var.yaml)
This workflow illustrates how to extract a specific item from a JSON list stored in a environment variable dynamically.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/68-ostypes.yml)
This workflow shows the os type value for each github runner os.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/69-run-on-push-to-rc.yml)
This workflow illustrates how to extract a semantic version from a Release Candidate branch name.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/70-post-failure.yml) - AS EXPECTED
This workflow illustrates how to execute a job when a previous job fails (post failure operations).
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/71-many-outputs-python.yml)
This workflow illustrates how to save many outputs using a python script and the GITHUB_OUTPUT file.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/72-trigger-on-comment.yml)
This workflow illustrates how to start a workflow by commenting using a specific keyword in a Pull Request review.
[](https://github.com/GuillaumeFalourd/poc-github-actions/actions/workflows/73-if-file-exists.yml) - AS EXPECTED
This workflow illustrates how to check if a file exists in a workflow after a failure, to perform some custom operations.