setup-deploy-keys

🚧 This project is still a work in progress 🚧

This action sets up SSH configuration for using GitHub deploy keys in a GitHub Action

creating / appending to ~/.ssh/config file
creating / appending to ~/.ssh/known_hosts file
inserting private keys with provided data

More information about deploy keys can be found here

Getting Started

TODO: write more documentation

# github workflow yml file
steps:
  - name: setting up deploy keys
    uses: schie/setup-deploy-keys@master
    with:
      deployKeyData: ${{secrets.DEPLOY_KEYS}}
  - installation step

This project expects a project secret called DEPLOY_KEYS that contains JSON in the following format

[
  {
    "privateKey": "-----BEGIN OPENSSH PRIVATE KEY-----\n {SOME PRIVATE KEY JANK} \n-----END OPENSSH PRIVATE KEY-----\n",
    "publicKey": "ssh-rsa {SOME GOBBLY GOOK} {some_user}@{some_host}",
    "packageName": "my-package-name",
    "ownerName": "my-user-or-org",
    "hostAlias": "{my-package-name}.github.com"
  },
   //...
]

License

The scripts and documentation in this project are released under the MIT License

Contributions

Contributions are welcome!