Skip to content

Commit

Permalink
docs: update continious integration documentaiton
Browse files Browse the repository at this point in the history
Added a section detailing how to perform a production deployment.

Co-authored-by: amtins <andre.martins@rts.ch>
  • Loading branch information
jboix and amtins committed Oct 30, 2024
1 parent 13ec577 commit db13a05
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -104,18 +104,22 @@ Here’s a more concise description of the GitHub Actions setup without listing
### Continuous Integration
This project automates its development workflow using GitHub Actions across two main workflows:
quality checks and releases.
This project automates its own development workflow using GitHub Actions:
1. **Quality Check for Pull Requests**
Triggered on every pull request to the `main` branch, this workflow ensures the code passes
static analysis and unit tests. It guarantees that any new code meets quality standards before
being merged into the main branch.
static analysis and unit tests.
2. **Release Workflow**
When changes are pushed to the `main` branch, this workflow handles versioning and releases using
When changes are pushed to `main`, this workflow handles versioning and releases with
`semantic-release`. It automatically bumps the version, generates release notes, creates a tag,
and publishes a Docker image to an Amazon ECR repository.
and publishes a Docker image to Amazon ECR. This new version is automatically deployed to the
development environment.
3. **Production deployment**
To deploy a specific version to production, manually trigger the `Promote Version to Stable`
workflow from the Actions tab, inputting the desired version number (e.g., 1.0.0). This workflow
tags the selected version as stable in the ECR, and forces a new deployment on ECS.
## Contributing
Expand Down

0 comments on commit db13a05

Please sign in to comment.