Skip to content
This repository has been archived by the owner on Nov 26, 2023. It is now read-only.

Commit

Permalink
docs: update docs to latest changes
Browse files Browse the repository at this point in the history
  • Loading branch information
Techie-Pi authored Jan 23, 2022
1 parent ddda2a1 commit 50ecdbc
Showing 1 changed file with 9 additions and 7 deletions.
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,16 +21,18 @@ steps:
## How does it work?
The action does the following:
1. Copies the repository contents to the remote server on the specified folder
2. Runs ``npm ci``
2. Runs ``npm ci``or ``yarn install``
3. Runs ``pm2 restart <id>`` with the provided ID/Name
## Input arguments
### Required
- ``remote-path`` - _``Where do you want to copy the files to?``_
- ``host`` - _``What's the host IP address?``_
- ``username`` - _``What's the username that you're going to login into``_
- ``port`` - _``What's the port of SSH?``_ (default: ``22``)
- ``password`` - _``What's the password of the user?``_ (Note: in the future SSH Keys will be supported)
- ``pm2-id`` - _``What's the ID/Name of the PM2 application?``_
- ``remote-path`` - Where do you want to copy the files to?
- ``host`` - _What's the host IP address?
- ``username`` - What's the username that you're going to login into
- ``port`` - What's the port of SSH? (default: ``22``)
- ``password`` - What's the password of the user?`` (Note: in the future SSH Keys will be supported)
- ``automatic-pre-deploy`` - Should deploy automatically (default ``true``)
- ``yarn`` - Use yarn instead of npm (default ``false``)
- ``pm2-id`` - What's the ID/Name of the PM2 application?
> Note: Although sensitive information such as ``password`` is used through the input arguments, it's recommended to save it on ``Secrets``

0 comments on commit 50ecdbc

Please sign in to comment.