Commit Graph

73 Commits

Author SHA1 Message Date
Bo-Yi Wu 28428a13f5
docs: improve cross-platform clipboard support for key copying
- Add instructions to install `xclip` on Ubuntu before copying the private key
- Replace `clip` command with platform-specific commands (`pbcopy` for macOS and `xclip` for Ubuntu) for copying the private key

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2024-07-14 16:59:55 +08:00
Bo-Yi Wu 71d43ea0f7
docs: improve documentation and testing configurations
- Add note about the default value of `port` being `22` in the README

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2024-06-06 08:30:06 +08:00
Bo-Yi Wu f916346256
ci: refactor CI workflow and improve robustness (#320)
* ci: refactor CI workflow and improve robustness

- Update GitHub Actions checkout step from version 1 to version 4 in multiple jobs within the CI workflow

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

* docs: improve non-interactive shell command handling

- Add a Q&A section to the README with information on resolving 'command not found' errors for non-interactive shells
- Provide a solution involving editing `/etc/bash.bashrc` to ensure commands are added to the path in non-interactive shells

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

* docs: improve documentation and CI robustness

- Update acknowledgment for the interactive shell solution in the README.md file

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>

---------

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2024-05-04 19:52:33 +08:00
Bo-Yi Wu dd0f09ca07
docs: improve README clarity and completeness
- Update the README table formatting to include an additional column separator
- Add documentation for the SSH protocol version option in the README table

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2024-03-16 16:04:59 +08:00
Bo-Yi Wu fe44be0b96
docs: improve documentation and CI robustness
- Add backticks around `GITHUB_` and `INPUT_` in the README for clarity

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2024-03-16 15:47:10 +08:00
Kushal Dhakal 8a779a5b1a
docs: describe true usage of allenvs parameter (#301) 2024-03-16 09:43:37 +08:00
Bo-Yi Wu 9b978f09f2
chore: update SSH action version in README files
- Update the version of the `appleboy/ssh-action` from `v1.0.2` to `v1.0.3` in the README.md file
- Update the version of the `appleboy/ssh-action` from `v1.0.2` to `v1.0.3` in the README.zh-tw.md file

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2024-01-07 19:48:12 +08:00
Bo-Yi Wu 029f5b4aee
docs: update README.md and improve code documentation
- Add a new entry for `request_pty` in the README.md file

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2024-01-07 19:40:43 +08:00
Bo-Yi Wu 2451745138
chore: update SSH action version in README files
- Update the version of the `appleboy/ssh-action` to `v1.0.2` in the `README.md` and `README.zh-tw.md` files.

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2024-01-01 14:23:27 +08:00
Bo-Yi Wu 8f94919856
chore: update appleboy/ssh-action to v1.0.1 in documentation
- Update appleboy/ssh-action from v1.0.0 to v1.0.1 in README.md
- Update appleboy/ssh-action from v0.1.10 to v1.0.1 in README.zh-tw.md

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2023-12-26 15:13:15 +08:00
appleboy 4330a1ea48 docs: update appleboy/ssh-action version in README
- Update the version of `appleboy/ssh-action` from `v0.2.0` to `v1.0.0` in multiple places in the README.

Signed-off-by: appleboy <appleboy.tw@gmail.com>
2023-07-23 10:05:56 +08:00
appleboy 55dabf81b4 docs: update appleboy/ssh-action version in README
- Update the version of `appleboy/ssh-action` from `v0.1.10` to `v0.2.0` in multiple places in the README file.

Signed-off-by: appleboy <appleboy.tw@gmail.com>
2023-07-23 10:01:08 +08:00
appleboy 8d9094f3b1 docs: "Introduce `allenvs` option for shell script execution"
- Add a new option `allenvs` in the README to pass all environment variables to the shell script.

Signed-off-by: appleboy <appleboy.tw@gmail.com>
2023-07-23 09:57:59 +08:00
Bo-Yi Wu c7d850f6cd docs: improve readability and functionality across project
- Reformat input parameters in README.md as a table for better readability

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2023-06-04 11:08:59 +08:00
Bo-Yi Wu 2b7de38eed chore: update `appleboy/ssh-action` to latest version
- Update the version of `appleboy/ssh-action` from `v0.1.9` to `v0.1.10` in multiple files.

Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2023-04-13 12:18:50 +08:00
Bo-Yi Wu 334f9259f2
chore: update action configuration for greater flexibility (#240)
- Update base image version from `1.6.12` to `1.6.13` in Dockerfile
- Add `envs_format` input with flexible configuration in action.yml
- Add a line to README.md pointing to action.yml for more information

fix https://github.com/appleboy/ssh-action/issues/213
2023-04-13 11:15:42 +08:00
Bo-Yi.Wu 6268c80dd6 docs: add external resources to README file
- Add a line linking to Golang and drone-ssh in the README file

Signed-off-by: Bo-Yi.Wu <appleboy.tw@gmail.com>
2023-04-04 17:56:49 +08:00
Bo-Yi.Wu 5f64c95280 chore: improve SSH key handling and documentation
- Upgrade the ssh-action package from version `v0.1.8` to `v0.1.9`
- Update the ssh-keygen command to use `-t ed25519 -a 200 -C` flag with an email address
- Clarify how to pass environment variables as strings in the `env` object
- Add a command to check the fingerprint of an ed25519 key in the README
- Remove duplicate Host entry for `FooServer` in the Chinese version of the README

Signed-off-by: Bo-Yi.Wu <appleboy.tw@gmail.com>
2023-04-04 17:37:29 +08:00
Bo-Yi Wu 6a1b59d972 docs: add chinese 2023-03-03 10:45:48 +08:00
Bo-Yi Wu e4a881008d docs(readme): update 2023-03-03 10:26:23 +08:00
Bo-Yi Wu 51b83ba474 docs: format 2023-03-03 10:22:51 +08:00
Bo-Yi.Wu b601429988 docs: update to v0.1.8 version
Signed-off-by: Bo-Yi.Wu <appleboy.tw@gmail.com>
2023-02-28 17:18:27 +08:00
Bo-Yi.Wu c1965ddd25 docs: upgrade to v0.1.7
Signed-off-by: Bo-Yi.Wu <appleboy.tw@gmail.com>
2023-01-08 09:13:12 +08:00
Bo-Yi Wu 4a03da89e5 docs: update to v0.1.6 2022-12-09 10:32:49 +08:00
Leo Schick db9be1d5f2
use fixed version in documentation (#199) 2022-12-09 10:16:07 +08:00
Inaction f23dd5c681
docs(readme): Fix typo (#191) 2022-11-26 18:24:18 +08:00
Fabián Delgado cc051b07ed
Update README.md (#188) 2022-10-17 22:00:39 +08:00
Bo-Yi Wu f9010ff7f1 docs: remove FAQ section
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2022-07-29 21:24:53 +08:00
Ayanwola Ayomide e1116226a0
updated readme envs option in example (#172) 2022-07-29 21:19:55 +08:00
Alister MacCormack f82e23f1a3
updated README to include OpenSSH comments (#161) 2022-07-29 20:58:30 +08:00
Bo-Yi Wu ed1f3fc7c1 docs: problem with an EC2 instance
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2022-07-29 20:54:56 +08:00
Bo-Yi Wu c7671d858f docs: update format
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2022-02-06 15:15:00 +08:00
Nicklas Frahm 1a8b3784ea
Document setup of SSH host fingerprint validation (#120) 2021-05-15 23:05:07 +08:00
Bo-Yi Wu 29007ce6fb chore: update ssh key part
part from https://github.com/appleboy/ssh-action/issues/80
2021-05-09 21:11:10 +08:00
h1dden-da3m0n e59c0ee97a
docu(restructure): update readme structure and add ed25519 ssh key instructions (#113) 2021-04-04 05:59:44 +08:00
Bo-Yi Wu 61e292b601 docs: fix typo
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2020-11-17 10:54:18 +08:00
Bo-Yi Wu 1d1b21ca96
Support multiple host with different port (#94) 2020-11-17 10:51:06 +08:00
Bo-Yi Wu fd39ef0f18
Update README.md 2020-10-31 07:03:29 +08:00
Bo-Yi Wu ffff33f8fe docs: update readme 2020-08-13 01:06:27 +08:00
Himanshu Garg 8bd4933b73
Instructions to use SSH Key (#77) 2020-08-13 01:03:55 +08:00
Yashu Mittal a2f91cbad1
(info) Pass env variable as string (#69) 2020-07-08 16:46:24 +08:00
Bo-Yi Wu 5711a203b3
fix typo 2020-06-05 09:05:02 +08:00
Bo-Yi Wu b315fb5f98
Update README.md 2020-06-05 09:03:15 +08:00
Bo-Yi Wu 03b440e441 docs: add cipher parameter 2020-05-24 13:13:09 +08:00
Bo-Yi Wu c9eebc1cde
chore: support use_insecure_cipher (#57) 2020-05-24 10:54:31 +08:00
Daniel Hwang 6b00175bad
add support for fingerprint: (#54) 2020-05-19 14:21:26 +08:00
Bo-Yi Wu a912e225ec chore: Add limitation in readme 2020-05-08 19:05:53 +08:00
Bo-Yi Wu 03b5d10ad6 docs: update desctiption 2020-02-13 21:17:09 +08:00
Bo-Yi Wu fcfb760891 docs: add GitHub syntax (#30)
see: https://help.github.com/en/actions/automating-your-workflow-with-github-actions/contexts-and-expression-syntax-for-github-actions

fixed: https://github.com/appleboy/ssh-action/issues/28
2020-02-09 11:37:56 +08:00
Alexey Kleandrov cfe9c45db6
docs: sync parameter (#25) 2020-01-30 22:40:33 +08:00