Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/boromir674/automated-workflows
Automated Workflows for implementing Git Ops and CI/CD.
https://github.com/boromir674/automated-workflows
automated-deployment cicd github-workflows pipelines reusable-workflows
Last synced: 21 days ago
JSON representation
Automated Workflows for implementing Git Ops and CI/CD.
- Host: GitHub
- URL: https://github.com/boromir674/automated-workflows
- Owner: boromir674
- License: agpl-3.0
- Created: 2023-11-07T16:17:35.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-09-08T21:04:42.000Z (5 months ago)
- Last Synced: 2024-11-11T16:44:39.217Z (3 months ago)
- Topics: automated-deployment, cicd, github-workflows, pipelines, reusable-workflows
- Language: Python
- Homepage: https://automated-workflows.readthedocs.io/
- Size: 521 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# CI/CD Workflows
[](https://github.com/boromir674/automated-workflows/actions/workflows/cicd.yml)
[](https://automated-workflows.readthedocs.io)
[](https://github.com/boromir674/automated-workflows/blob/main/LICENSE)
`Reusable Workflows` for **CI/CD Pipelines**, implemented in `Github Actions`.
> **Live Documentation** at **https://automated-workflows.readthedocs.io.**
- Source: https://github.com/boromir674/automated-workflows
- CI: https://github.com/boromir674/automated-workflows/actions
## Reusable Workflows
- **CI/CD**
- [**Docker**](.github/workflows/docker.yml): Build Docker image and Push to Dockerhub.
- [**Python Build**](.github/workflows/test_build.yml): Build n Test Python Distributions.
- [**PyPI**](.github/workflows/pypi_env.yml): Upload Python distribution to PyPI
- [**Docs Build**](.github/workflows/policy_docs.yml): Docs Site Build with `Mkdocs` or `Sphinx`
- [**Lint**](.github/workflows/lint.yml): Static Code Analysis
- [**Code Visualization**](.github/workflows/python_imports.yml): Visualize Python Code as an `svg` Graph of `Module Imports`
- **Git Ops**
- [**Open PR to Boarding**](.github/workflows/go-pr-to-boarding.yml): Open a PR on a **Boarding Branch**
- [**Acceptance as Single Job Status**](.github/workflows/go-single-status.yml): Model **Git Ops Acceptance** as one Job
> [!NOTE]
> See the **API** `References` in the [Documentation](https://automated-workflows.readthedocs.io/en/main/) for all the `Reusable Workflows`.
## Git Ops Processes
- [**`release-me`**](https://automated-workflows.readthedocs.io/en/main/topics/gitops/): Ship your Branch to `main` with 2 Steps/PRs
> [!NOTE]
> See the [`how-to` **Guides**](https://automated-workflows.readthedocs.io/en/main/guides/gitops/) for implementing your **Git Ops Processes**.
## Quickstart
### Docker
Continuously **Publish to Dockerhub** using [`docker.yml`](.github/workflows/docker.yml).
[//]: <> (Style text in .)
#### Prerequisites
- GitHub account.
- Access to a repository.
- Passing a proper DOCKER_USER from `context`
- Passing a proper DOCKER_PASSWORD from `secrets`
### `Use Case 1: CI/Continuous Deployment`
"We publish to Dockerhub **only Tested Builds**"
Quick-start
```mermaid
graph LR
workflow_triggered("CI Start") --> rt{"Do QA?"}
rt -- Yes --> cit
cit["Run Tests"] --> ifpass{"Passed?"}
ifpass -- "Yes" --> run_docker["Publish Docker"]
ifpass -- "No" --> do_not_publish_broken_build["Decline Publish"]
rt -- No --> do_not_publish_broken_build
```
```yaml
env:
DO_QA: true
jobs:
build_n_test:
runs-on: ubuntu-latest
if: always() && ${{ env.DO_QA == 'true' }}
steps:
- run: echo "Build Code and run Tests"
call_docker_job:
needs: build_n_test
uses: boromir674/automated-workflows/.github/workflows/docker.yml@test
with:
DOCKER_USER: ${{ vars.DOCKER_USER }}
acceptance_policy: 2
image_slug: "my_app_name"
image_tag: "1.0.0"
tests_pass: ${{ needs.build_n_test.result == 'success' }}
tests_run: ${{ !contains(fromJSON('["skipped", "cancelled"]'), needs.build_n_test.result) }}
secrets:
DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
```
### `Use Case 2: CI/Continuous Delivery`
- "Publish to Dockerhub Builds bearing a **'Tests Passed'** or a **'Tests Skipped'**"
Quick-start
- Not tested builds (ie when CI Test Job is skipped for any reason), are still treated as eligible for Docker Publish.
- Useful to trigger Docker Job, without waiting for Tests.
```mermaid
graph LR
workflow_triggered("CI Start") --> rt{"Run QA?"}
rt -- Yes --> cit
cit["Run Tests"] --> ifpass{"Passed?"}
ifpass -- "Yes" --> run_docker["Publish Docker"]
ifpass -- "No" --> do_not_publish_broken_build["Decline Publish"]
rt -- No --> run_docker
```
```yaml
env:
DO_QA: false
jobs:
build_n_test:
runs-on: ubuntu-latest
if: always() && ${{ env.DO_QA == 'true' }}
steps:
- run: echo "Build Code and run Tests"
call_docker_job:
needs: build_n_test
uses: boromir674/automated-workflows/.github/workflows/docker.yml@test
with:
DOCKER_USER: ${{ vars.DOCKER_USER }}
acceptance_policy: 3
image_slug: "my_app_name"
image_tag: "1.0.0"
tests_pass: ${{ needs.build_n_test.result == 'success' }}
tests_run: ${{ !contains(fromJSON('["skipped", "cancelled"]'), needs.build_n_test.result) }}
secrets:
DOCKER_PASSWORD: ${{ secrets.DOCKER_PASSWORD }}
```
## License
- See the [LICENSE](LICENSE) file to read the License, under which this Project is released under.
- This project is licensed under the [GNU Affero General Public License v3.0](LICENSE).
- Free software: `GNU Affero General Public License v3.0`