Rewrite deploy action as a native Node action with simplified v2 UX - #20
Merged
Merged
Conversation
|
Important Review skippedAuto reviews are disabled on base/target branches other than the default branch. 🗂️ Base branches to auto review (2)
Please check the settings in the CodeRabbit UI or the ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Advanced Run ID: You can disable this status message by setting the Use the checkbox below for a quick retry:
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
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.
Summary
Introduces the focused v2 interface on top of #19:
The default mode packages the committed contents of checked-out
HEADand submits them through the app-token deployment endpoint.Deployment modes
HEAD;working-directorysupports monorepos and places that directory's contents at the tar rootHEADas deployment metadata, falling back toGITHUB_SHAwhen no repository is availabletar-file, resolved inside the GitHub workspaceThe action rejects
imagewithtar-fileand rejects a non-defaultworking-directoryin either explicit mode.Breaking changes from v1
branchHEADbecomes the default deployment source./deploy.tarfallbacktar-file: ./deploy.tarExisting v1 tags remain unchanged.
Documentation
The README is organized around quick start, image deployment with
docker/build-push-action, monorepos, prepared tar files, inputs, private registries, and v1 migration.Tests
25 tests cover input validation, mutually exclusive modes, source and image commit metadata, monorepo archive roots, explicit tar uploads, API headers, trailing server slashes, useful API errors, special-character paths, temporary archive cleanup, interrupted responses, SHA fallback behavior, and normalized workspace-root paths.
Manual verification
Ran the committed
dist/index.jsthrough all three modes against a local CapRover-compatible HTTP server:Verified the endpoint, authentication headers, multipart requests, image definition, metadata, logs, and accepted-response handling.
This PR is stacked on #19. After #19 merges, retarget this PR to
main.Review fixes
HEADfor image metadata, withGITHUB_SHAas the no-checkout fallback./