Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hapag-lloyd/workflow-templates
Template files for workflows
https://github.com/hapag-lloyd/workflow-templates
repository setup template
Last synced: about 21 hours ago
JSON representation
Template files for workflows
- Host: GitHub
- URL: https://github.com/hapag-lloyd/workflow-templates
- Owner: Hapag-Lloyd
- License: mit
- Created: 2024-05-06T15:08:09.000Z (10 months ago)
- Default Branch: main
- Last Pushed: 2024-08-07T11:58:18.000Z (7 months ago)
- Last Synced: 2024-08-07T13:27:58.470Z (7 months ago)
- Topics: repository, setup, template
- Language: Shell
- Homepage:
- Size: 402 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# Workflow-Templates
This repository stores templates used to set up workflows for new repositories.
## Set up a new repository
```bash
git clone https://github.com/Hapag-Lloyd/Workflow-Templates.git workflow-templates
./update_workflows.sh
```
Search for `TODO` in the copied files and replace the placeholders with the correct values. The same script can be used to update
all files in case of major changes in the templates.
## What you get
### Default setup
- Release management is done with [semantic-release](https://github.com/semantic-release/semantic-release). Releases are automatically
tagged and published on GitHub. Special releases for Maven Central and Terraform modules are supported.
- stale issue and PR management
- welcome message for contributors
- linters for all files
- PRs are checked for semantic commit titles to ensure an automatic release
- ChatOps to run workflows from comments
- a `.config/dictionaries/project.txt` file for the spell checker exceptions
## For Developers - Repository Layout
1. Add all workflows to `.github/workflows/`, otherwise they can't be referenced from the repositories.
2. Workflows with `this_` prefix are used for this repository only.
3. Workflows with `default_` prefix are added to every new repository. Otherwise, use the correct prefix for the project type.
The script to set up the workflows for new repositories is `./update_workflows.sh`. It copies the necessary files to the new
repository. It starts with the default workflows and adds the specific ones based on the project type. In case of a filename clash,
the specific template overwrites the default one (exception: `.gitignore` These files are concatenated).
Use
```bash
# USE_REPOSITORY
# push:
# branches:
# - main
# /USE_REPOSITORY
```
in the file to describe the triggers which should be used in the repository. The script will automatically replace the triggers
marked with `USE_WORKFLOW` which are valid within this repository only.
Make sure that this block is well formatted, otherwise the update script will fail in the related repository due to prettier.
### Simulate the update
Use the `simulate.sh` script to check the changes before applying them to the repository. The script
- creates a new repository called `simulate-*` and applies the changes there
- updates the `workflow.txt` dictionary in your current branch
### Spell Checker
1. Add the words to the `.config/dictionaries/workflow.txt` file.
2. `.config/dictionaries/project.txt` file is used for the project specific words of the project being set up.
3. All other dictionaries are managed by the `Repository-Template-*` repositories.