Versions and docs#301
Open
paigewilliams wants to merge 4 commits into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates the container publishing workflow to run on GitHub Release publication (instead of pushes to main) and introduces semantic version tagging for the published web and proxy images. It also improves repository contribution documentation by adding a Mermaid development lifecycle diagram to the README and repositioning the coverage badge.
Changes:
- Switch Docker image publish workflow trigger from
pushonmaintorelease.published(while retainingworkflow_dispatch). - Add shared image tagging rules (SHA + semver tags +
latest) viadocker/metadata-actionfor bothwebandproxyimages. - Add a “Development Cycle” Mermaid diagram and move the coverage badge into the README header.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 4 comments.
| File | Description |
|---|---|
| README.md | Adds a Mermaid development-cycle diagram and moves the coverage badge into the header. |
| .github/workflows/create-and-publish-docker-images.yml | Publishes images on release events and adds metadata-based semantic version tagging for web and proxy. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| type=semver,pattern=v{{version}} | ||
| type=semver,pattern=v{{major}}.{{minor}} | ||
| type=semver,pattern=v{{major}} | ||
| type=raw,latest |
Collaborator
Author
There was a problem hiding this comment.
this works in wcbluepages. Keeping for now.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes the "Create and publish web and proxy Docker images" github action to be triggered on merging to
mainto being triggered on creating a new release. It also adds version tags to the web and proxy images. I learned about YAML anchors to use the same tags for the web and proxy images.I also added a mermaid chart on the development lifecycle to better document on how to contribute to this repo.