Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sindre0830/workflow-templates
GitHub Workflows for different programming languages.
https://github.com/sindre0830/workflow-templates
automated-testing cmake code-quality code-review continuous-integration cpp golang gradle java nodejs python react rust workflows
Last synced: 24 days ago
JSON representation
GitHub Workflows for different programming languages.
- Host: GitHub
- URL: https://github.com/sindre0830/workflow-templates
- Owner: sindre0830
- License: mit
- Created: 2022-06-17T17:11:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2022-06-27T14:58:33.000Z (over 2 years ago)
- Last Synced: 2024-07-30T17:47:15.179Z (5 months ago)
- Topics: automated-testing, cmake, code-quality, code-review, continuous-integration, cpp, golang, gradle, java, nodejs, python, react, rust, workflows
- Homepage:
- Size: 395 KB
- Stars: 13
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS
Awesome Lists containing this project
README
# Workflow Templates
Templates of GitHub Workflows for different programming languages. Place the workflow file you want to use in ```.github/workflows/```. In the ```examples/``` directory, there are coding examples that the workflows run on.
Want to **contribute**? Open up a pull request or an issue! My goal is to have as many languages here as possible so any contribution is welcome.
### List of available templates
| Language | Author(s) |
| -------- | --------- |
| [Python](.github/workflows/python.yml) | [sindre0830](https://github.com/sindre0830) |
| [Golang](.github/workflows/golang.yml) | [sindre0830](https://github.com/sindre0830) |
| [Node / React](.github/workflows/node.yml) | [sindre0830](https://github.com/sindre0830) |
| [CMake / C++](.github/workflows/cmake.yml) | [sindre0830](https://github.com/sindre0830) |
| [Rust](.github/workflows/rust.yml) | [sindre0830](https://github.com/sindre0830) |
| [Gradle / Java](.github/workflows/java.yml) | [MikAoJK](https://github.com/MikAoJK) |
### Base layout
Base workflow layout for every programming language:
```yml
name: Name of workflow
# when to run the workflow
on:
push:
...
pull_request:
workflow_dispatch:
# instructions the workflow will perform
jobs:
build:
# environment to run on
runs-on: ubuntu-latest
# steps to perform
steps:
- uses: actions/checkout@v2
- name: Set up language
...
- name: Install dependencies
working-directory: path/to/folder
...
- name: Build program
working-directory: path/to/folder
...
- name: Run tests
working-directory: path/to/folder
...
- name: Syntax checker
working-directory: path/to/folder
...
```
Under the section that decides when to run the workflow you can decide on specific paths. Below you can see an example where the workflow will only run when changes is pushed to the ```path/to/file/main.py``` file or when anything changes in the ```path/to/folder/``` directory. This limits the amount of time the workflow is run and helps with reducing the time it takes to get the results. It is recommended to add the workflow file to this list as it triggers the workflow to run on any changes you apply to it, testing the workflow instantly.
Pull requests aren't set to any specific path since it's recommended to run every workflow before merging the branch with main. This reduces the likelihood of mistakes being pushed to the main branch.
The last trigger is the ```workflow_dispatch```. This allows for a manual trigger of the workflow on the branch of your wish. You should get the option under the action page of the workflow.
```yml
on:
push:
paths:
- 'path/to/file/main.py'
- 'path/to/folder/**'
pull_request:
```
Under the section that is named ```set up language``` you decide the programming language that is relevant for the workflow. Below you have an example with Python. The Python version needs to be changed to whats relevant to your needs.
```yml
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.9.10'
```
The rest of the steps are all different depending on the language. The step running the tests might not be relevant for each workflow so might not be present. You can change the path in the working directory to ```.``` if you wish to work in the root directory.