cloudflare/wrangler-action
1
0
Fork 0
mirror of https://github.com/cloudflare/wrangler-action.git synced 2024-11-22 10:03:24 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update README, better output on missing secret

Browse source
This commit is contained in:
Kristian Freeman 2019-10-15 16:13:22 -05:00
parent bdf9196cd6
commit 599ff4dc4b
2 changed files with 22 additions and 22 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
README.md
View file

@ -19,27 +19,27 @@ jobs:
steps: steps:
- uses: actions/checkout@master - uses: actions/checkout@master
- name: Publish - name: Publish
uses: signalnerve/wrangler-action@0.1.0 uses: signalnerve/wrangler-action@0.1.4
with: with:
apiKey: ${{ secrets.CLOUDFLARE_API_KEY }} apiKey: ${{ secrets.apiKey }}
email: ${{ secrets.CLOUDFLARE_EMAIL }} email: ${{ secrets.email }}
``` ```
## Configuration ## Configuration
You'll need to configure Wrangler using GitHub's Secrets feature - go to "Settings -> Secrets" and add your Cloudflare API key and email (for help finding these, see the [Workers documentation](https://developers.cloudflare.com/workers/quickstart/#finding-your-cloudflare-api-keys)). Your API key and email are encrypted by GitHub, and the action won't print them into logs, so they should be safe! You'll need to configure Wrangler using GitHub's Secrets feature - go to "Settings -> Secrets" and add your Cloudflare API key and email (for help finding these, see the [Workers documentation](https://developers.cloudflare.com/workers/quickstart/#finding-your-cloudflare-api-keys)). Your API key and email are encrypted by GitHub, and the action won't print them into logs, so they should be safe!
With your API key and email set as secrets for your repository, pass them to the action in the `with` block of your workflow: With your API key and email set as secrets for your repository, pass them to the action in the `with` block of your workflow. Below, I've set the secret names to `apiKey` and `email`:
```yaml ```yaml
jobs: jobs:
deploy: deploy:
name: Deploy name: Deploy
steps: steps:
uses: signalnerve/wrangler-action@0.1.0 uses: signalnerve/wrangler-action@0.1.4
with: with:
apiKey: ${{ secrets.CLOUDFLARE_API_KEY }} apiKey: ${{ secrets.apiKey }}
email: ${{ secrets.CLOUDFLARE_EMAIL }} email: ${{ secrets.email }}
``` ```
Optionally, you can also pass an `environment` key to the action. If you're using Wrangler's [environments](https://github.com/cloudflare/wrangler/blob/master/docs/content/environments.md) feature, you can customize _where_ the action deploys to by passing the matching environment in the `with` block of your workflow: Optionally, you can also pass an `environment` key to the action. If you're using Wrangler's [environments](https://github.com/cloudflare/wrangler/blob/master/docs/content/environments.md) feature, you can customize _where_ the action deploys to by passing the matching environment in the `with` block of your workflow:
@ -49,10 +49,10 @@ jobs:
deploy: deploy:
# ... previous configuration ... # ... previous configuration ...
steps: steps:
uses: signalnerve/wrangler-action@0.1.0 uses: signalnerve/wrangler-action@0.1.4
with: with:
# ... api key and email ... # ... api key and email ...
environment: "production" environment: 'production'
``` ```
## Troubleshooting ## Troubleshooting
@ -77,10 +77,10 @@ jobs:
steps: steps:
- uses: actions/checkout@master - uses: actions/checkout@master
- name: Build site - name: Build site
run: "npm run build" run: 'npm run build'
- name: Publish - name: Publish
uses: signalnerve/wrangler-action@0.1.0 uses: signalnerve/wrangler-action@0.1.4
with: with:
apiKey: ${{ secrets.CLOUDFLARE_API_KEY }} apiKey: ${{ secrets.apiKey }}
email: ${{ secrets.CLOUDFLARE_EMAIL }} email: ${{ secrets.email }}
``` ```

2
entrypoint.sh
View file

@ -10,7 +10,7 @@ export WRANGLER_HOME="/github/workspace"
sanitize() { sanitize() {
if [ -z "${1}" ] if [ -z "${1}" ]
then then
>&2 echo "Unable to find ${2}. Did you set secrets.${2}?" >&2 echo "Unable to find ${2}. Did you add a GitHub secret called key ${2}, and pass in secrets.${2} in your workflow?"
exit 1 exit 1
fi fi
} }