Skip to content

doc: Sync Docker Hub description with README #17

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
baixiac merged 3 commits into from
Jul 14, 2025
Merged

doc: Sync Docker Hub description with README #17

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
77e5d42
doc: sync Docker Hub description with README
baixiac Jul 11, 2025
0ed6c61
doc: switch off doc syncing on PRs after testing
baixiac Jul 11, 2025
59fbed9
chore: address GH linting warnings
baixiac Jul 14, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions .github/workflows/docker-extra.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -99,3 +99,12 @@ jobs:
subject-name: ${{ env.REGISTRY }}/${{ env.DOCKER_IMAGE_NAME }}
subject-digest: ${{ steps.build_and_push_mlflow_ui.outputs.digest }}
push-to-registry: true

- name: Update Docker Hub description
if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
uses: peter-evans/dockerhub-description@v4
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
repository: ${{ env.DOCKER_IMAGE_NAME }}
readme-filepath: ./docker/mlflow/server/README.md
9 changes: 9 additions & 0 deletions .github/workflows/docker.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,3 +87,12 @@ jobs:
subject-name: ${{ env.REGISTRY }}/${{ env.DOCKER_IMAGE_NAME }}
subject-digest: ${{ steps.build_and_push_cms.outputs.digest }}
push-to-registry: true

- name: Update Docker Hub description
if: github.ref == 'refs/heads/main' && github.event_name != 'pull_request'
uses: peter-evans/dockerhub-description@v4
with:
username: ${{ secrets.DOCKERHUB_USERNAME }}
password: ${{ secrets.DOCKERHUB_TOKEN }}
repository: ${{ env.DOCKER_IMAGE_NAME }}
readme-filepath: ./README.md
2 changes: 2 additions & 0 deletions docker/mlflow/server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
## cogstack-mlflow-ui
A customised MLflow server configured for experiment tracking in CogStack projects.
Loading