Contributing Guide
Release Process
Contributing Guide
Release Process
The release process at Multiwoven is fully automated through GitHub Actions.
Here’s an overview of our automation stages, each facilitated by specific GitHub Actions:
1
Weekly Release Workflow
- Action: Release Workflow
- Description: Every Tuesday, a new release is automatically generated with a minor version tag (e.g., v0.4.0) following semantic versioning rules. This process also creates a pull request (PR) for release notes that summarize the changes in the new version.
- Additional Triggers: The same workflow can be manually triggered to create a patch version (e.g., v0.4.1 for quick fixes) or a major version (e.g., v1.0.0 for significant architectural changes). This is done using the workflow dispatch feature in GitHub Actions.
2
Automated Release Notes on Merge
- Action: Create Release Note on Merge
- Description: When the release notes PR is merged, it triggers the creation of a new release with detailed release notes on GitHub.
3
Docker Image Releases
- Description: Docker images need to be manually released based on the newly created tags from the GitHub Actions.
- Actions:
-
Build and push Multiwoven server docker image to Docker Hub: This action handles the server-side Docker image push to docker hub with tag as latest and the new release tag i.e v0.4.0
-
Build and push Multiwoven UI docker image to Docker Hub: This action handles the user interface Docker image to docker hub with tag as latest and the new release tag i.e v0.4.0
-
Was this page helpful?