Update dry run for atmos vendor pull to support ssh + detailed SCP urls alignment v2 #1156
Conversation
📝 WalkthroughWalkthroughThis pull request updates the Atmos documentation. In the vendor pull command docs, a new section details how to use SSH and HTTPS for vendoring, including URL formatting rules and authentication priorities. Additionally, the configuration docs now include new environment variables for Bitbucket and GitLab authentication. No changes were made to public APIs. Changes
Assessment against linked issues
Possibly related PRs
Suggested reviewers
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
website/docs/cli/commands/vendor/vendor-pull.mdx (3)
111-120: New "Vendoring from SSH" Section Clarity
The new SSH vendoring section is a valuable addition that clearly outlines both SCP‐style and explicit SSH approaches. It meets the PR objective for enhanced dry run output and detailed URL conversion. Consider adding a brief note on security best practices when handling SSH keys in automated systems.
121-128: SCP-style Source Example is Clear
The SCP-style example effectively demonstrates how Atmos rewrites an SCP-style URL. If possible, you might add a short sentence explaining the transformation logic (e.g. that the colon separator is replaced by thessh://syntax), to help users understand the underlying conversion better.
214-222: Refine Wording and Ellipsis in HTTPS Resolution Rules
In the "How HTTPS URLs Are Resolved" section, consider revising the phrase “it is used as-is” to a stronger expression such as “it remains unchanged.” Additionally, replace the three-dot ellipsis (...) with the typographical ellipsis character (…) for a cleaner look. For example:-If a **full HTTPS URL** is provided (`git::https://github.com/...`), it is used as-is. +If a **full HTTPS URL** is provided (`git::https://github.com/…`), it remains unchanged.🧰 Tools
🪛 LanguageTool
[style] ~216-~216: Consider using a different verb to strengthen your wording.
Context: ...lved When resolving Git sources, Atmos follows these rules: 1. If a *full HTTPS URL...(FOLLOW_OBEY)
[style] ~218-~218: Consider using the typographical ellipsis character here instead.
Context: ...1. If a full HTTPS URL is provided (git::https://github.com/...), it is used as-is. No token data is i...(ELLIPSIS)
website/docs/cli/configuration/configuration.mdx (1)
681-684: New Environment Variables for Authentication
The new entries forATMOS_BITBUCKET_TOKEN,ATMOS_BITBUCKET_USERNAME, andATMOS_GITLAB_TOKENare well documented and integrate nicely with the rest of the configuration details. Consider adding a short usage note or example in the description to illustrate their practical application in real-world scenarios.
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
website/docs/cli/commands/vendor/vendor-pull.mdx(2 hunks)website/docs/cli/configuration/configuration.mdx(2 hunks)
🧰 Additional context used
🪛 LanguageTool
website/docs/cli/commands/vendor/vendor-pull.mdx
[style] ~216-~216: Consider using a different verb to strengthen your wording.
Context: ...lved When resolving Git sources, Atmos follows these rules: 1. If a *full HTTPS URL...
(FOLLOW_OBEY)
[style] ~218-~218: Consider using the typographical ellipsis character here instead.
Context: ...1. If a full HTTPS URL is provided (git::https://github.com/...), it is used as-is. No token data is i...
(ELLIPSIS)
⏰ Context from checks skipped due to timeout of 90000ms (8)
- GitHub Check: Build (macos-latest, macos)
- GitHub Check: Build (windows-latest, windows)
- GitHub Check: Lint (golangci)
- GitHub Check: Lint (golangci)
- GitHub Check: website-deploy-preview
- GitHub Check: Analyze (go)
- GitHub Check: Analyze (go)
- GitHub Check: Summary
🔇 Additional comments (2)
website/docs/cli/commands/vendor/vendor-pull.mdx (2)
137-145: Explicit SSH Sources Example Reviewed
The explicit SSH source example is concise and correctly shows that no URL rewriting is applied when thessh://prefix is provided. This aligns well with the intended functionality.
265-265: Dry-run Flag Addition Confirmed
The addition of the--dry-runflag to the command flags table is clear and well documented. This enhancement makes dry run behavior explicit and aligns with the overall PR improvements.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #1156 +/- ##
=======================================
Coverage 21.64% 21.64%
=======================================
Files 172 172
Lines 19292 19292
=======================================
Hits 4176 4176
Misses 14336 14336
Partials 780 780
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
Managed to fix #1076, closing this out as a duplicate |
what
This is a copy of #1076 that got too big and had issues with codecov results upload.
This PR upgrades the output of dry run mode for vendor pull command.
After the change is applied, the dry run mode shows
yet there's no actual files download.
Before ( component vendoring dry-run output)
After ( component vendoring dry-run output)
component.yaml, refer to the respective test case for details
Before ( generic vendoring dry-run output)
After ( generic vendoring dry-run output)
vendor.yaml, refer to the respective test case for detaails
why
Received feedback from in the parent PR
references
Copy of #1076
Summary by CodeRabbit