Setup SSH - GitHub Action
This action sets up your SSH key on Windows, macOS and Ubuntu Virtual Environments
Example usage
Setup for GitHub
name: Deployment
on:
push:
branches:
- main
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: LuisEnMarroquin/setup-ssh-action@v2.0.4
with:
SSHKEY: ${{ secrets.SSH }} # ----- BEGIN RSA PRIVATE KEY----- ...
- run: ssh -T git@github.com || trueSetup for your server
name: Deployment
on:
push:
branches:
- main
jobs:
deploy:
runs-on: ubuntu-latest
steps:
- uses: LuisEnMarroquin/setup-ssh-action@v2.0.4
with:
ORIGIN: ${{ secrets.HOST }} # example.com || 8.8.8.8
SSHKEY: ${{ secrets.SSH }} # ----- BEGIN RSA PRIVATE KEY----- ...
NAME: production
PORT: ${{ secrets.PORT }} # 3000
USER: ${{ secrets.USER }} # admin
- run: ssh production ls --helpInputs
| Key | Value Information | Required |
|---|---|---|
ORIGIN |
Where to log in, can be a Domain or IP address, defaults to github.com |
No |
SSHKEY |
Your SSH access key, it's better to store it on your repository secrets | Yes |
NAME |
How you can refer to the SSH key in the next commands, defaults to ORIGIN |
No |
PORT |
The port that will be on the SSH config | No |
USER |
The user that will be on the SSH config | No |
Your repo secrets are at: https://github.com/<username>/<repository>/settings/secrets
How to release new version
- Create deployable file
npm run build- Create a tag and push it
git tag -a v2.0.4 -m "Changed all files version to the proper one"
git push origin v2.0.4- Go to releases page and click
Draft a new release
https://github.com/LuisEnMarroquin/setup-ssh-action/releases
- Fill with correct data
- Title:
Released v2.0.4 - Description:
Paste contents from README.md
- Git add, commit and push your changes
gacp Changed all files version to the proper one- Validate that pipelines worked