Versions and docs#301
Conversation
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 |
There was a problem hiding this comment.
this works in wcbluepages. Keeping for now.
There was a problem hiding this comment.
Would be nice if Copilot cited sources to read up on:
- Whether current syntax is supported
- whether changes in accepted syntax is supported
- confirm that this recommended (untested) change is preferred over the current (tested) syntax
| type=semver,pattern=v{{version}} | ||
| type=semver,pattern=v{{major}}.{{minor}} | ||
| type=semver,pattern=v{{major}} | ||
| type=raw,latest |
There was a problem hiding this comment.
Would be nice if Copilot cited sources to read up on:
- Whether current syntax is supported
- whether changes in accepted syntax is supported
- confirm that this recommended (untested) change is preferred over the current (tested) syntax
|  No newline at end of file | ||
| ## Development Cycle | ||
|
|
||
| This project aims to follow a specific development cycle to ease collaboration and keep the different environments in sync. Below is a diagram of what the development lifecycle should look like: |
There was a problem hiding this comment.
This is a lot of content for README. I think it's great for an audience of potential contributors. Perhaps this content could be it's own doc and linked from here (as the others are linked).
Separate from this, I'd love (when there's time) to think hard about what audience we want to reach with the README, and how to route that audience.
Still - this is cool. I love flowcharts and this helps make the complexity far more readable.
| push: true | ||
| tags: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}/web:latest,${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}/web:${{ github.sha }} | ||
| labels: ${{ steps.meta.outputs.labels }} | ||
| tags: ${{ steps.meta-web.outputs.tags }} |
There was a problem hiding this comment.
This is much cleaner and (I hope) also reduces required user-configuration of local .env files.
There was a problem hiding this comment.
This is just for adding tags to docker images so that we have better observability of what versions folks are running. I'm hoping that this will be helpful as we have partners adopt docker deployment, we can debug with their exact docker image.
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.