ci(docker): sync Docker Hub overview from DOCKERHUB.md#61
Merged
Conversation
Add a Docker-Hub-tailored README (DOCKERHUB.md) with absolute image URLs (relative paths don't render on Docker Hub) and a dockerhub-readme job that mirrors it to the Docker Hub repository overview after each main build via peter-evans/dockerhub-description (pinned). Gated on main + DOCKER_HUB_USERNAME so forks are unaffected. Verified the configured PAT authenticates against the Docker Hub API (login 200). Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
![github-advanced-security[bot]](https://avatars.githubusercontent.com/in/57789?s=60&v=4){kind=small}
…dme job Resolves CodeQL 'Workflow does not contain permissions' — the job only checks out the repo (the Docker Hub update uses DOCKER_HUB_TOKEN), so contents: read is sufficient. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
There was a problem hiding this comment.
Pull request overview
Mirrors a Docker-Hub-optimized README (DOCKERHUB.md) to the Docker Hub repository overview via a new CI job, so Docker Hub visitors see a proper landing page kept in sync with main.
Changes:
- Bump NPM package version to
0.9.16. - Add
DOCKERHUB.mdwith Docker-Hub-friendly formatting (absolute image URLs, quick start, tags, env vars, links). - Add a
dockerhub-readmeworkflow job to syncDOCKERHUB.mdto Docker Hub onmain.
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 5 comments.
| File | Description |
|---|---|
| package.json | Version bump to 0.9.16. |
| DOCKERHUB.md | Adds Docker Hub overview content (quick start, tags, supported DBs, env vars, links). |
| .github/workflows/docker-build-push.yml | Adds a job to sync Docker Hub README from DOCKERHUB.md after main builds. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Comment on lines
+33
to
+37
| -e ADMIN_EMAIL=admin@libredb.org \ | ||
| -e ADMIN_PASSWORD=LibreDB.2026 \ | ||
| -e USER_EMAIL=user@libredb.org \ | ||
| -e USER_PASSWORD=LibreDB.2026 \ | ||
| -e JWT_SECRET=change-me-to-a-random-32-char-string \ |
| libredb/libredb-studio:latest | ||
| ``` | ||
|
|
||
| Open <http://localhost:3000> and log in with `admin@libredb.org` / `LibreDB.2026`. |
| | Tag | Pushed from | Use | | ||
| |-----|-------------|-----| | ||
| | `latest` | `main` | Latest stable build | | ||
| | `X.Y.Z` (e.g. `0.9.15`) | `main` / release | Pin a specific version (recommended for production) | |
| - **DeepWiki docs:** <https://deepwiki.com/libredb/libredb-studio> | ||
| - **License:** MIT | ||
|
|
||
| <sub>This page is generated from <a href="https://github.com/libredb/libredb-studio/blob/main/DOCKERHUB.md">DOCKERHUB.md</a> and synced automatically on each release.</sub> |
Comment on lines
+174
to
+178
| dockerhub-readme: | ||
| name: Sync Docker Hub README | ||
| needs: build-and-push | ||
| if: ${{ github.ref == 'refs/heads/main' && vars.DOCKER_HUB_USERNAME != '' }} | ||
| runs-on: ubuntu-latest |
- DOCKERHUB.md: use placeholder passwords in the docker run quick start (was hardcoded LibreDB.2026) and align the login line; make the image-tag example version-agnostic; fix footer to say 'every main build' not 'release'. - Gate the dockerhub-readme job on the token too: expose the build job's dockerhub_enabled output (which checks DOCKER_HUB_TOKEN) and require it in the job's if, so main stays green if the token is absent/rotated. (secrets can't be referenced directly in a job-level if.) Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Resolves CodeQL actions/unpinned-tag (#75) in this workflow. Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
Author
|
Thanks @copilot — addressed all review points:
Also resolved the CodeQL findings: #78 (missing permissions → added |
|
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.
Mirrors the GitHub-maintained
DOCKERHUB.mdto the Docker Hub repository overview on everymainbuild, so visitors to hub.docker.com/r/libredb/libredb-studio see a proper landing page.DOCKERHUB.md— Docker-Hub-tailored README with absoluteraw.githubusercontent.comimage URLs (relative paths render broken on Docker Hub), quick start, image-tag table, supported DBs, env vars, deploy links.dockerhub-readmejob —peter-evans/dockerhub-description(pinned to v5.0.0 SHA), gated ongithub.ref == main && vars.DOCKER_HUB_USERNAME != ''(fork-safe).DOCKER_HUB_TOKENPAT authenticates against the Docker Hub API (login → 200), so the description PATCH will succeed.After merge, the main build syncs the overview automatically.