Skip to content

docs: Add docker-compose.yml and GitHub Actions examples to README#31

Merged
azu merged 2 commits intomainfrom
claude/add-docker-readme-IxXlh
Apr 3, 2026
Merged

docs: Add docker-compose.yml and GitHub Actions examples to README#31
azu merged 2 commits intomainfrom
claude/add-docker-readme-IxXlh

Conversation

@azu
Copy link
Copy Markdown
Owner

@azu azu commented Apr 3, 2026

Summary

This PR expands the documentation by adding examples of dockerfile-pin usage with docker-compose and GitHub Actions workflows, in addition to the existing Dockerfile examples.

Changes

  • Added a new "#### Dockerfile" section header to better organize the existing Dockerfile example
  • Added a new "#### docker-compose.yml" section with before/after examples showing how dockerfile-pin pins image digests in docker-compose services, including handling of the build directive (which is skipped when present)
  • Added a new "#### GitHub Actions" section with before/after examples demonstrating digest pinning in GitHub Actions workflow files, including proper handling of Docker image references in container and services configurations, while skipping non-Docker image references like actions/checkout@v4

Notable Details

  • The examples demonstrate that dockerfile-pin intelligently skips images that have a build directive in docker-compose
  • The GitHub Actions example shows that the tool correctly distinguishes between Docker image references (which get pinned) and action references (which are skipped)
  • All examples follow the same before/after format for consistency with the existing documentation

https://claude.ai/code/session_01Y9Jr5JxLUeLwYNx36miXFz

claude and others added 2 commits April 3, 2026 12:38
…o README

The README only had before/after for Dockerfile FROM lines. Added similar
examples for docker-compose.yml (image fields, build directive skipping)
and GitHub Actions (container, services, docker:// steps).

https: //claude.ai/code/session_01Y9Jr5JxLUeLwYNx36miXFz
Co-authored-by: azu <azu@users.noreply.github.com>
Replace placeholder digests with actual registry digests for postgres:16.2,
node:24, postgres:18, and ghcr.io/astral-sh/uv:latest.

https: //claude.ai/code/session_01Y9Jr5JxLUeLwYNx36miXFz
Co-authored-by: azu <azu@users.noreply.github.com>
@azu azu changed the title Add docker-compose.yml and GitHub Actions examples to README docs: Add docker-compose.yml and GitHub Actions examples to README Apr 3, 2026
@azu azu added the documentation Improvements or additions to documentation label Apr 3, 2026
@azu azu marked this pull request as ready for review April 3, 2026 12:56
Copy link
Copy Markdown
Contributor

@devin-ai-integration devin-ai-integration Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@azu azu merged commit ca57578 into main Apr 3, 2026
3 checks passed
@azu azu deleted the claude/add-docker-readme-IxXlh branch April 3, 2026 13:05
@github-actions github-actions Bot mentioned this pull request Apr 3, 2026
@azu azu added the Type: Documentation Documentation only changes label Apr 3, 2026
azu pushed a commit that referenced this pull request Apr 3, 2026
<!-- Release notes generated using configuration in .github/release.yml
at main -->

## What's Changed

### Features

* feat: Add glob pattern matching for --ignore-images and config file
support by @azu in #30

### Documentation
* Reorganize README examples: move glob patterns after write options by
@azu in #32
* docs: Add docker-compose.yml and GitHub Actions examples to README by
@azu in #31


**Full Changelog**:
v1.1.0...v1.2.0

Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation Type: Documentation Documentation only changes

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants