docs for kamal github action #89
Conversation
| - The known hosts file for your server. You can generate this by running `ssh-keyscan <your-server-ip>`. | ||
|
|
||
| With these secrets set, the GitHub Actions workflow will be able to deploy your app to Kamal. To test it | ||
| go to the "Actions" tab in your repository, click on the "Kamal Deploy" workflow, and then click "Run workflow". |
There was a problem hiding this comment.
(It will also then run on every push to main, right?)
There was a problem hiding this comment.
I think we also have to tell them to uncomment the workflow_run section of the deploy file, right?
There was a problem hiding this comment.
As it stands you can run it manually. For automated deploys you have to uncomment the lines in the workflow file as indicated by the comment in that file.
| - The known hosts file for your server. You can generate this by running `ssh-keyscan <your-server-ip>`. | ||
|
|
||
| With these secrets set, the GitHub Actions workflow will be able to deploy your app to Kamal. To test it | ||
| go to the "Actions" tab in your repository, click on the "Kamal Deploy" workflow, and then click "Run workflow". |
There was a problem hiding this comment.
I think we also have to tell them to uncomment the workflow_run section of the deploy file, right?
| - A private key you use to SSH into your server. This must be a passwordless key. | ||
| - `SSH_KNOWN_HOSTS` | ||
| - The known hosts file for your server. You can generate this by running `ssh-keyscan <your-server-ip>`. | ||
|
|
There was a problem hiding this comment.
We might also want a note here about it being tied to docker hub with a one-liner about how to chnage it.
There was a problem hiding this comment.
I've added a note about this. Depending on the repo there may be different steps required. I could add a second file for AWS ECR which is a bit different.
|
@snopoke How would app-specific environment variables be handled if you were using this? Are those just managed outside this workflow? |
| - `SSH_KEY` | ||
| - A private key you use to SSH into your server. This must be a passwordless key. | ||
| - `SSH_KNOWN_HOSTS` | ||
| - The known hosts file for your server. You can generate this by running `ssh-keyscan <your-server-ip>`. |
There was a problem hiding this comment.
What exactly do I use here? If I run that command I get something like this:
# www.translationcreator.com:22 SSH-2.0-OpenSSH_8.9p1 Ubuntu-3ubuntu0.10
www.translationcreator.com ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAA....
# www.translationcreator.com:22 SSH-2.0-OpenSSH_8.9p1 Ubuntu-3ubuntu0.10
www.translationcreator.com ecdsa-sha2-nistp256 AAAAE2VjZHNhLXNoYTItbmlzdHA....
# www.translationcreator.com:22 SSH-2.0-OpenSSH_8.9p1 Ubuntu-3ubuntu0.10
# www.translationcreator.com:22 SSH-2.0-OpenSSH_8.9p1 Ubuntu-3ubuntu0.10
Do I just paste that whole thing into the environment variable?
Yes, they are handled outside this workflow (same as normal Kamal deploys - except for the first one) |
|
|
||
| ### Deploy with GitHub Actions | ||
|
|
||
| As of version 2024.8, your repository also includes a GitHub Actions workflow that can be used to deploy your app to Kamal |
There was a problem hiding this comment.
| As of version 2024.8, your repository also includes a GitHub Actions workflow that can be used to deploy your app to Kamal | |
| As of version 2024.9, your repository also includes a GitHub Actions workflow that can be used to deploy your app to Kamal |
Hopefully
There was a problem hiding this comment.
Needs to be updated to the actual release version
|
(don't merge till released) |
Co-authored-by: Simon Kelly <[email protected]>
See https://github.com/czue/pegasus/pull/296