docs(readme): better wording for script_path property#387
Merged
Conversation
Better wording for `script_path` property.
WalkthroughThe README.md file was updated to clarify that the Changes
Poem
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
🔇 Additional comments (1)
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:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. 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
CodeRabbit Configuration File (
|
appleboy
approved these changes
Jun 18, 2025
Owner
|
@kontur Thanks. |
Closed
luketainton
pushed a commit
to luketainton/actions_gha-workflows
that referenced
this pull request
Nov 8, 2025
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [appleboy/ssh-action](https://github.com/appleboy/ssh-action) | action | patch | `v1.2.2` -> `v1.2.3` | --- ### Release Notes <details> <summary>appleboy/ssh-action (appleboy/ssh-action)</summary> ### [`v1.2.3`](https://github.com/appleboy/ssh-action/releases/tag/v1.2.3) [Compare Source](appleboy/ssh-action@v1.2.2...v1.2.3) ##### Changelog ##### Features - [`20d5c5b`](appleboy/ssh-action@20d5c5b): feat: add configurable curl insecure flag to GitHub action ([@​appleboy](https://github.com/appleboy)) ##### Bug fixes - [`170eebb`](appleboy/ssh-action@170eebb): fix: enhance binary download flow with robust error handling ([#​394](appleboy/ssh-action#394)) ([@​appleboy](https://github.com/appleboy)) ##### Enhancements - [`b27b9f8`](appleboy/ssh-action@b27b9f8): chore: refactor system to improve efficiency and update API usage ([@​appleboy](https://github.com/appleboy)) - [`0e19dd9`](appleboy/ssh-action@0e19dd9): chore: improve robustness and consistency across multiple scripts ([@​appleboy](https://github.com/appleboy)) ##### Refactor - [`b6690ee`](appleboy/ssh-action@b6690ee): refactor: improve error handling and code readability across scripts ([#​374](appleboy/ssh-action#374)) ([@​appleboy](https://github.com/appleboy)) ##### Build process updates - [`2b3c650`](appleboy/ssh-action@2b3c650): ci: unify and enhance GitHub workflow configurations ([@​appleboy](https://github.com/appleboy)) - [`ffd1eec`](appleboy/ssh-action@ffd1eec): ci: add workflow step for multi-command SSH testing ([#​386](appleboy/ssh-action#386)) ([@​appleboy](https://github.com/appleboy)) - [`53f5c5c`](appleboy/ssh-action@53f5c5c): ci: add automated Trivy security scanning via GitHub Actions ([@​appleboy](https://github.com/appleboy)) ##### Documentation updates - [`52a1840`](appleboy/ssh-action@52a1840): docs: update SSH action version to v1 in all README files ([#​372](appleboy/ssh-action#372)) ([@​appleboy](https://github.com/appleboy)) - [`689de3c`](appleboy/ssh-action@689de3c): docs: improve CLI messaging and error clarity for users ([@​appleboy](https://github.com/appleboy)) - [`9ca1cd2`](appleboy/ssh-action@9ca1cd2): docs: document the new `curl_insecure` configuration option ([@​appleboy](https://github.com/appleboy)) - [`bd83ba7`](appleboy/ssh-action@bd83ba7): docs: document and configure drone-ssh version usage ([#​381](appleboy/ssh-action#381)) ([@​appleboy](https://github.com/appleboy)) - [`b80f638`](appleboy/ssh-action@b80f638): docs: rewrite and unify documentation across all supported languages ([@​appleboy](https://github.com/appleboy)) - [`c7fbbc9`](appleboy/ssh-action@c7fbbc9): docs: add table of contents to multilingual README files ([@​appleboy](https://github.com/appleboy)) - [`4d84f05`](appleboy/ssh-action@4d84f05): docs: revamp and unify multi-language readme documentation ([@​appleboy](https://github.com/appleboy)) - [`8f3cc07`](appleboy/ssh-action@8f3cc07): docs: add comprehensive tables of contents to all README files ([@​appleboy](https://github.com/appleboy)) - [`8745f95`](appleboy/ssh-action@8745f95): docs: restructure and clarify parameter documentation across all readmes ([@​appleboy](https://github.com/appleboy)) - [`57f6f35`](appleboy/ssh-action@57f6f35): docs(readme): better wording for script\_path property ([#​387](appleboy/ssh-action#387)) ([@​kontur](https://github.com/kontur)) - [`3ca8a7c`](appleboy/ssh-action@3ca8a7c): docs: clarify script\_path usage in Chinese remote execution docs ([@​appleboy](https://github.com/appleboy)) - [`c680069`](appleboy/ssh-action@c680069): docs: add comprehensive documentation for project setup and usage ([@​appleboy](https://github.com/appleboy)) - [`91f3272`](appleboy/ssh-action@91f3272): docs: add Trivy security scan badge to all documentation ([@​appleboy](https://github.com/appleboy)) </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR is behind base branch, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiI0Mi4xLjMiLCJ1cGRhdGVkSW5WZXIiOiI0Mi4xLjMiLCJ0YXJnZXRCcmFuY2giOiJtYWluIiwibGFiZWxzIjpbInR5cGUvZGVwZW5kZW5jaWVzIl19--> Reviewed-on: https://git.tainton.uk/actions/gha-workflows/pulls/43 Co-authored-by: renovate[bot] <renovate-bot@git.tainton.uk> Co-committed-by: renovate[bot] <renovate-bot@git.tainton.uk>
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
2 participants
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.
Better wording for
script_pathproperty.I also misunderstood this to be a script on the remote that will be called. As pointed out in this comment here it refers to a path of a script in the repo.
Summary by CodeRabbit
script_pathparameter in the SSH command settings to specify that the file should be located within the repository and that its commands are executed remotely.