Skip to content

docs: document v2 action API alongside v1 in README - #120

Merged
piob-io merged 1 commit into
mainfrom
devin/1784735102-document-v2-api
Jul 22, 2026
Merged

piob-io merged 1 commit into
mainfrom
devin/1784735102-document-v2-api

Conversation

@piob-io

@piob-io piob-io commented Jul 22, 2026 •

Copy link
Copy Markdown
Contributor

Summary

README-only change documenting the v2 action API next to v1 (both stay supported):

  • Single realistic v2 usage example (checkout + setup with cache-key: my-repo/api + build-push); v2 referenced as @v2 (tag to be created from release/v2 before merge), recommended for new setups in the version-pinning notes.
  • Per-version input tables: v2 adds the required cache-key (explicit cache scoping), drops max-cache-size-mb (replaced by BuildKit's native time-based GC), and marks skip-integrity-check as a deprecated no-op.
  • Cache management section contrasts v2 (native GC, no config) with v1's max-cache-size-mb, including caveats: pruning is end-of-job (not a usage limit), and shared caches across build targets can evict each other's layers.
  • No links to docs.blacksmith.sh yet; they'll be added once the main documentation update (useblacksmith/docs#248) lands, since this PR merges first.

Link to Devin session: https://app.devin.ai/sessions/6ee33a7c3e5848e9a39d85439b161082
Requested by: @piob-io

@piob-io piob-io self-assigned this Jul 22, 2026
@devin-ai-integration

Copy link
Copy Markdown
Contributor

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR. Add '(aside)' to your comment to have me ignore it.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@devin-ai-integration
devin-ai-integration Bot force-pushed the devin/1784735102-document-v2-api branch 6 times, most recently from 3eee376 to d72dfe8 Compare July 22, 2026 17:29
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@devin-ai-integration
devin-ai-integration Bot force-pushed the devin/1784735102-document-v2-api branch from d72dfe8 to c02bf59 Compare July 22, 2026 17:43
@piob-io
piob-io marked this pull request as ready for review July 22, 2026 17:46
@piob-io
piob-io requested review from adityamaru and taha-au July 22, 2026 17:47
@piob-io
piob-io merged commit 8e5ad81 into main Jul 22, 2026
12 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants