diff --git a/.eslintrc.yml b/.eslintrc.yml index bbe1f10..07b4cfe 100644 --- a/.eslintrc.yml +++ b/.eslintrc.yml @@ -3,9 +3,9 @@ env: # https://eslint.org/docs/user-guide/configuring#specifying-environments es6: true node: true extends: - - eslint:recommended - - plugin:@typescript-eslint/eslint-recommended - - plugin:@typescript-eslint/recommended +- eslint:recommended +- plugin:@typescript-eslint/eslint-recommended +- plugin:@typescript-eslint/recommended plugins: - import - "@typescript-eslint" diff --git a/.github/workflows/verify-on-macos.yml b/.github/workflows/verify-on-macos.yml index ff8daf5..469120b 100644 --- a/.github/workflows/verify-on-macos.yml +++ b/.github/workflows/verify-on-macos.yml @@ -12,7 +12,7 @@ jobs: - name: Install SSH key uses: ./. with: - private-key: ${{ secrets.SSH_KEY }} + key: ${{ secrets.SSH_KEY }} known_hosts: ${{ secrets.KNOWN_HOSTS }} # optional - name: print created files run: ls -l ~/.ssh @@ -27,7 +27,7 @@ jobs: - name: Install SSH key uses: ./. with: - private-key: ${{ secrets.SSH_KEY }} + key: ${{ secrets.SSH_KEY }} known_hosts: ${{ secrets.KNOWN_HOSTS }} # optional name: ssh_key_name # optional config: | # optional diff --git a/.github/workflows/verify-on-ubuntu.yml b/.github/workflows/verify-on-ubuntu.yml index 84f5c45..e6548e1 100644 --- a/.github/workflows/verify-on-ubuntu.yml +++ b/.github/workflows/verify-on-ubuntu.yml @@ -12,7 +12,7 @@ jobs: - name: Install SSH key uses: ./. with: - private-key: ${{ secrets.SSH_KEY }} + key: ${{ secrets.SSH_KEY }} known_hosts: ${{ secrets.KNOWN_HOSTS }} # optional - name: print created files run: ls -l ~/.ssh @@ -27,7 +27,7 @@ jobs: - name: Install SSH key uses: ./. with: - private-key: ${{ secrets.SSH_KEY }} + key: ${{ secrets.SSH_KEY }} known_hosts: ${{ secrets.KNOWN_HOSTS }} # optional name: ssh_key_name # optional config: | # optional diff --git a/.github/workflows/verify-on-ubuntu1604.yml b/.github/workflows/verify-on-ubuntu1604.yml index bd2c085..b3cce08 100644 --- a/.github/workflows/verify-on-ubuntu1604.yml +++ b/.github/workflows/verify-on-ubuntu1604.yml @@ -12,7 +12,7 @@ jobs: - name: Install SSH key uses: ./. with: - private-key: ${{ secrets.SSH_KEY }} + key: ${{ secrets.SSH_KEY }} known_hosts: ${{ secrets.KNOWN_HOSTS }} # optional - name: print created files run: ls -l ~/.ssh @@ -27,7 +27,7 @@ jobs: - name: Install SSH key uses: ./. with: - private-key: ${{ secrets.SSH_KEY }} + key: ${{ secrets.SSH_KEY }} known_hosts: ${{ secrets.KNOWN_HOSTS }} # optional name: ssh_key_name # optional config: | # optional diff --git a/.github/workflows/verify-on-windows.yml b/.github/workflows/verify-on-windows.yml index 615be88..003466f 100644 --- a/.github/workflows/verify-on-windows.yml +++ b/.github/workflows/verify-on-windows.yml @@ -12,7 +12,7 @@ jobs: - name: Install SSH key uses: ./. with: - private-key: ${{ secrets.SSH_KEY }} + key: ${{ secrets.SSH_KEY }} known_hosts: ${{ secrets.KNOWN_HOSTS }} # optional - name: print created files run: ls ~/.ssh @@ -27,7 +27,7 @@ jobs: - name: Install SSH key uses: ./. with: - private-key: ${{ secrets.SSH_KEY }} + key: ${{ secrets.SSH_KEY }} known_hosts: ${{ secrets.KNOWN_HOSTS }} # optional name: ssh_key_name # optional config: | # optional diff --git a/CHANGELOG.md b/CHANGELOG.md index c3519a4..55bebe3 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0. ### Changed +* rename `private-key` to `key` * rename `known-hosts` to `known_hosts` ## [1.6.4] - 2020-01-27 diff --git a/README.md b/README.md index 0fd7f60..ac298dc 100644 --- a/README.md +++ b/README.md @@ -27,7 +27,7 @@ steps: - name: Install SSH key uses: shimataro/ssh-key-action@v1 with: - private-key: ${{ secrets.SSH_KEY }} + key: ${{ secrets.SSH_KEY }} name: id_rsa # optional known_hosts: ${{ secrets.KNOWN_HOSTS }} # optional config: ${{ secrets.CONFIG }} # ssh_config; optional @@ -42,7 +42,7 @@ See [Workflow syntax for GitHub Actions](https://help.github.com/en/articles/wor If you want to install multiple keys, call this action multiple times. It is useful for port forwarding. -**NOTE:** When this action is called multiple times, **the contents of `known_hosts` and `config` will be appended**. `private-key` must be saved as different name, by using `name` option. +**NOTE:** When this action is called multiple times, **the contents of `known_hosts` and `config` will be appended**. `key` must be saved as different name, by using `name` option. ```yaml runs-on: ubuntu-latest @@ -50,7 +50,7 @@ steps: - name: Install SSH key of bastion uses: shimataro/ssh-key-action@v1 with: - private-key: ${{ secrets.SSH_KEY_OF_BASTION }} + key: ${{ secrets.SSH_KEY_OF_BASTION }} name: id_rsa-bastion known_hosts: ${{ secrets.KNOWN_HOSTS_OF_BASTION }} config: | @@ -61,7 +61,7 @@ steps: - name: Install SSH key of target uses: shimataro/ssh-key-action@v1 with: - private-key: ${{ secrets.SSH_KEY_OF_TARGET }} + key: ${{ secrets.SSH_KEY_OF_TARGET }} name: id_rsa-target known_hosts: ${{ secrets.KNOWN_HOSTS_OF_TARGET }} # will be appended! config: | # will be appended! @@ -126,15 +126,15 @@ The scripts and documentation in this project are released under the [MIT Licens See [CHANGELOG.md](CHANGELOG.md). [image-build]: https://github.com/shimataro/ssh-key-action/workflows/Build/badge.svg?event=push&branch=v1 -[link-build]: https://github.com/shimataro/ssh-key-action +[link-build]: https://github.com/shimataro/ssh-key-action/actions?query=workflow%3ABuild [image-verify-windows]: https://github.com/shimataro/ssh-key-action/workflows/Windows/badge.svg?event=push&branch=v1 -[link-verify-windows]: https://github.com/shimataro/ssh-key-action +[link-verify-windows]: https://github.com/shimataro/ssh-key-action/actions?query=workflow%3AWindows [image-verify-macos]: https://github.com/shimataro/ssh-key-action/workflows/macOS/badge.svg?event=push&branch=v1 -[link-verify-macos]: https://github.com/shimataro/ssh-key-action +[link-verify-macos]: https://github.com/shimataro/ssh-key-action/actions?query=workflow%3AmacOS [image-verify-ubuntu]: https://github.com/shimataro/ssh-key-action/workflows/Ubuntu/badge.svg?event=push&branch=v1 -[link-verify-ubuntu]: https://github.com/shimataro/ssh-key-action +[link-verify-ubuntu]: https://github.com/shimataro/ssh-key-action/actions?query=workflow%3AUbuntu [image-verify-ubuntu1604]: https://github.com/shimataro/ssh-key-action/workflows/Ubuntu%2016.04/badge.svg?event=push&branch=v1 -[link-verify-ubuntu1604]: https://github.com/shimataro/ssh-key-action +[link-verify-ubuntu1604]: https://github.com/shimataro/ssh-key-action/actions?query=workflow%3A%22Ubuntu+16.04%22 [image-release]: https://img.shields.io/github/release/shimataro/ssh-key-action.svg [link-release]: https://github.com/shimataro/ssh-key-action/releases [image-license]: https://img.shields.io/github/license/shimataro/ssh-key-action.svg diff --git a/action.yml b/action.yml index c786c48..aef5b4e 100644 --- a/action.yml +++ b/action.yml @@ -6,8 +6,8 @@ branding: icon: "terminal" color: "gray-dark" inputs: - private-key: - description: "private SSH key" + key: + description: "SSH private key" required: true name: description: "SSH key file name (default: id_rsa)" diff --git a/lib/main.js b/lib/main.js index 7ec4714..b97cccb 100644 --- a/lib/main.js +++ b/lib/main.js @@ -18,7 +18,7 @@ function main() { const files = [ { name: core.getInput("name"), - contents: core.getInput("private-key", { + contents: core.getInput("key", { required: true, }), options: { diff --git a/lib/main.js.map b/lib/main.js.map index 6148a6d..43bb0e4 100644 --- a/lib/main.js.map +++ b/lib/main.js.map @@ -1 +1 @@ -{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;;;;;;;AAAA,uCAAyB;AACzB,2CAA6B;AAE7B,oDAAsC;AAStC;;GAEG;AACH,SAAS,IAAI;IAEZ,IACA;QACC,MAAM,KAAK,GAAe;YACzB;gBACC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;gBAC3B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,aAAa,EAAE;oBACtC,QAAQ,EAAE,IAAI;iBACd,CAAC;gBACF,OAAO,EAAE;oBACR,IAAI,EAAE,KAAK;oBACX,IAAI,EAAE,IAAI;iBACV;aACD;YACD;gBACC,IAAI,EAAE,aAAa;gBACnB,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;gBACjD,OAAO,EAAE;oBACR,IAAI,EAAE,KAAK;oBACX,IAAI,EAAE,GAAG;iBACT;aACD;YACD;gBACC,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAC5C,OAAO,EAAE;oBACR,IAAI,EAAE,KAAK;oBACX,IAAI,EAAE,GAAG;iBACT;aACD;SACD,CAAC;QAEF,0BAA0B;QAC1B,MAAM,IAAI,GAAG,gBAAgB,EAAE,CAAC;QAChC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC3C,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE;YACrB,SAAS,EAAE,IAAI;YACf,IAAI,EAAE,KAAK;SACX,CAAC,CAAC;QAEH,eAAe;QACf,KAAI,MAAM,IAAI,IAAI,KAAK,EACvB;YACC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/C,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;SACxD;QAED,OAAO,CAAC,GAAG,CAAC,8BAA8B,OAAO,gBAAgB,CAAC,CAAC;KACnE;IACD,OAAM,GAAG,EACT;QACC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;KAC5B;AACF,CAAC;AAED;;;GAGG;AACH,SAAS,gBAAgB;IAExB,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAClC,IAAG,IAAI,KAAK,SAAS,EACrB;QACC,MAAM,KAAK,CAAC,GAAG,OAAO,iBAAiB,CAAC,CAAC;KACzC;IAED,OAAO,IAAI,CAAC;AACb,CAAC;AAED;;;GAGG;AACH,SAAS,UAAU;IAElB,IAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,EAC/B;QACC,UAAU;QACV,OAAO,aAAa,CAAC;KACrB;IAED,gBAAgB;IAChB,OAAO,MAAM,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAAC,KAAa;IAE/B,IAAG,KAAK,CAAC,MAAM,KAAK,CAAC,EACrB;QACC,sBAAsB;QACtB,OAAO,EAAE,CAAC;KACV;IAED,OAAO,KAAK,KAAK,EAAE,CAAC;AACrB,CAAC;AAED,IAAI,EAAE,CAAC"} \ No newline at end of file +{"version":3,"file":"main.js","sourceRoot":"","sources":["../src/main.ts"],"names":[],"mappings":";;;;;;;;;AAAA,uCAAyB;AACzB,2CAA6B;AAE7B,oDAAsC;AAStC;;GAEG;AACH,SAAS,IAAI;IAEZ,IACA;QACC,MAAM,KAAK,GAAe;YACzB;gBACC,IAAI,EAAE,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;gBAC3B,QAAQ,EAAE,IAAI,CAAC,QAAQ,CAAC,KAAK,EAAE;oBAC9B,QAAQ,EAAE,IAAI;iBACd,CAAC;gBACF,OAAO,EAAE;oBACR,IAAI,EAAE,KAAK;oBACX,IAAI,EAAE,IAAI;iBACV;aACD;YACD;gBACC,IAAI,EAAE,aAAa;gBACnB,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,aAAa,CAAC,CAAC;gBACjD,OAAO,EAAE;oBACR,IAAI,EAAE,KAAK;oBACX,IAAI,EAAE,GAAG;iBACT;aACD;YACD;gBACC,IAAI,EAAE,QAAQ;gBACd,QAAQ,EAAE,SAAS,CAAC,IAAI,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC;gBAC5C,OAAO,EAAE;oBACR,IAAI,EAAE,KAAK;oBACX,IAAI,EAAE,GAAG;iBACT;aACD;SACD,CAAC;QAEF,0BAA0B;QAC1B,MAAM,IAAI,GAAG,gBAAgB,EAAE,CAAC;QAChC,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;QAC3C,EAAE,CAAC,SAAS,CAAC,OAAO,EAAE;YACrB,SAAS,EAAE,IAAI;YACf,IAAI,EAAE,KAAK;SACX,CAAC,CAAC;QAEH,eAAe;QACf,KAAI,MAAM,IAAI,IAAI,KAAK,EACvB;YACC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YAC/C,EAAE,CAAC,aAAa,CAAC,QAAQ,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,OAAO,CAAC,CAAC;SACxD;QAED,OAAO,CAAC,GAAG,CAAC,8BAA8B,OAAO,gBAAgB,CAAC,CAAC;KACnE;IACD,OAAM,GAAG,EACT;QACC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;KAC5B;AACF,CAAC;AAED;;;GAGG;AACH,SAAS,gBAAgB;IAExB,MAAM,OAAO,GAAG,UAAU,EAAE,CAAC;IAC7B,MAAM,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;IAClC,IAAG,IAAI,KAAK,SAAS,EACrB;QACC,MAAM,KAAK,CAAC,GAAG,OAAO,iBAAiB,CAAC,CAAC;KACzC;IAED,OAAO,IAAI,CAAC;AACb,CAAC;AAED;;;GAGG;AACH,SAAS,UAAU;IAElB,IAAG,OAAO,CAAC,QAAQ,KAAK,OAAO,EAC/B;QACC,UAAU;QACV,OAAO,aAAa,CAAC;KACrB;IAED,gBAAgB;IAChB,OAAO,MAAM,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,SAAS,SAAS,CAAC,KAAa;IAE/B,IAAG,KAAK,CAAC,MAAM,KAAK,CAAC,EACrB;QACC,sBAAsB;QACtB,OAAO,EAAE,CAAC;KACV;IAED,OAAO,KAAK,KAAK,EAAE,CAAC;AACrB,CAAC;AAED,IAAI,EAAE,CAAC"} \ No newline at end of file diff --git a/src/main.ts b/src/main.ts index 0eb46bd..b3aa60c 100644 --- a/src/main.ts +++ b/src/main.ts @@ -20,7 +20,7 @@ function main(): void const files: FileInfo[] = [ { name: core.getInput("name"), - contents: core.getInput("private-key", { + contents: core.getInput("key", { required: true, }), options: {