From 1b4f8f1fd951c4311340c3c986814fb29e1fd00e Mon Sep 17 00:00:00 2001 From: Nelson Chen Date: Fri, 21 Jun 2019 08:39:23 -0700 Subject: [PATCH] Update README.md --- README.md | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index da7b4b4..3a1e18e 100644 --- a/README.md +++ b/README.md @@ -7,8 +7,10 @@ Please ensure a `requirements.txt` is present for your site and installs ## Secrets - - `GIT_DEPLOY_KEY`: provide the private key for a [deploy key][1] - - *WARNING*, this should be considered deprecated. A future version of this action will use the `GITHUB_TOKEN` secret instead. + - `GIT_DEPLOY_KEY`: provide an SSH private key for a [deploy key][1] + - This is an alternative to `GITHUB_TOKEN` [which currently can't build pages][gt_limit]. + - Personal Access Tokens are not desired either since they grant access to your + *whole* account. ## Environment variables @@ -21,4 +23,6 @@ Extracted from https://github.com/desertpy/desertpy-pelican. It is not used there anymore though. For most sites though, this should suffice. - [1]: https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys +[1]: https://developer.github.com/v3/guides/managing-deploy-keys/#deploy-keys + +[gt_limit]: https://github.com/maxheld83/ghpages/pull/18#issuecomment-485274829