This repository serves as a centralized location for storing reusable workflows used to run CI processes for Armory-ATIPO team's projects.
Reusable workflows are predefined sequences of CI steps or tasks that can be easily shared and reused across different projects or repositories. By centralizing and sharing common workflows, this repository promotes code reusability, standardization, and efficiency.
You call our reusable workflow by using the uses keyword. Unlike when you are using actions within a workflow, you call reusable workflows directly within a job, and not from within job steps.
jobs.<job_id>.uses
You reference reusable workflow files using the following syntax:
armory-io/atipo-github-workflows/.github/workflows/{filename}@{ref}
{ref} can be a SHA, a release tag, or a branch name. Using the commit SHA is the safest for stability and security. For more information, see Security hardening for GitHub Actions.
You can call multiple workflows, referencing each in a separate job.
jobs:
# Reference using release tag
generate-manifests:
uses: armory-io/atipo-github-workflows/.github/workflows/generate-manifests.yml@v1
secrets: inherit
with:
kustomize_version: "5.0.3"
kustomize_overlay_paths: "tests/generate-manifests/kustomize/dev,tests/generate-manifests/kustomize/prod"
# Reference using branch name
create-release:
uses: armory-io/atipo-github-workflows/.github/workflows/create-release.yml@main
secrets: inherit
with:
is_prerelease: false
is_draft: false
# Reference using SHA
rollback-release:
uses: armory-io/atipo-github-workflows/.github/workflows/rollback-release.yml@4b6ff9de46240299430a28d52277d4071fdc1d78
secrets: inherit
with:
is_prerelease: false
is_draft: falseYou should only use the workflows listed below.
Please note that workflows located in the .github/workflows/ folder that are not listed below are specific CI workflows intended only for this repository. You cannot use them as reusable workflows in your own project.
This workflows automatically calculates next release tag (base on semver), generates changelog and creates a release for your project.
Please note that this workflow will increase the patch version after each run. For example, if your latest release version is v1.0.0, the release version generated by this workflow after the next run will be v1.0.1.
As for prerelease versions, v1.0.0-beta0 will become v1.0.0-beta1.
Inputs & Outputs:
See create-release.yml for more details.
Example Usage:
name: Create Release
on:
push:
branches:
- main
jobs:
create-release:
uses: armory-io/atipo-github-workflows/.github/workflows/create-release.yml@main
secrets: inherit
with:
is_prerelease: false
is_draft: falseThis workflow will help you render Kustomize manifests and compare the changes of the rendered files with what is currently present in the default branch. It will then send these changes as a comment on your pull request.
Please note that this workflow is designed to run with the event on.pull_request.
Inputs & Outputs:
See generate-manifests.yml for more details.
Example Usage:
name: Generate manifests
on:
pull_request:
branches:
- main
jobs:
generate-manifests:
uses: armory-io/atipo-github-workflows/.github/workflows/generate-manifests.yml@main
secrets: inherit
with:
kustomize_version: "5.0.3"
kustomize_overlay_paths: "kustomize/dev,kustomize/prod"This workflow will help you patch a YAML manifest in your project based on the input it receives.
Inputs & Outputs:
See patch-manifest.yml for more details.
Example Usage:
name: Patch manifest
on:
repository_dispatch:
types:
- PatchManifest
jobs:
update_versions:
uses: armory-io/atipo-github-workflows/.github/workflows/patch-manifest.yml@main
secrets: inherit
with:
kustomize_version: "5.0.3"
kustomize_overlay_paths: "tests/generate-manifests/kustomize/dev"
manifest_file_path: "tests/generate-manifests/kustomize/dev/deploy.yaml"
default_ref: "main"
patch_manifest: |
${{ toJson(github.event.client_payload.patch_content) }}A workflow to run pre-commit.
Inputs & Outputs:
See pre-commit.yml for more details.
Example Usage:
name: Pre Commit
on:
pull_request:
branches:
- main
jobs:
precommit:
uses: armory-io/atipo-github-workflows/.github/workflows/pre-commit.yml@mainThis action will rollback/delete a Github release.
Inputs & Outputs:
See rollback-release.yml for more details.
Example Usage:
name: Rollback Github (Pre)Release
on:
workflow_dispatch:
inputs:
version:
description: '(Pre)Release to revert; This will cause a deploy to the previous stable version'
type: string
required: true
jobs:
precommit:
uses: armory-io/atipo-github-workflows/.github/workflows/rollback-release.yml@main
secrets: inherit
with:
version: ${{ inputs.version }}For development details, see the contributing guide.