Skip to content

Commit 1db6752

Browse files
authored
docs(readme): update
1 parent 1963a3e commit 1db6752

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,7 @@ they are deployed to. Action will find and mark all deployments as `inactive` a
9494
<br />
9595

9696
### Obtain A Token
97+
9798
For certain operations _(like deleting an environment)_, your GitHub Action will need additional permissions that the default `github.token` simply doesn't have.
9899

99100
<br />
@@ -144,7 +145,7 @@ In this case, a [GitHub App](https://docs.github.com/en/developers/apps/getting-
144145
private-key: ${{ secrets.GH_APP_PRIVATE_KEY }}
145146

146147
- name: 🗑 Delete deployment environment
147-
uses: Aetherinox/delete-deploy-env-action@v2.2.3
148+
uses: Aetherinox/delete-deploy-env-action@v3
148149
with:
149150
# Use a JWT created with your GitHub App's private key
150151
token: ${{ steps.get-token.outputs.token }}
@@ -177,11 +178,13 @@ In this case, a [GitHub App](https://docs.github.com/en/developers/apps/getting-
177178
<br />
178179

179180
## Usage
181+
180182
To use this workflow, view the following examples below:
181183

182184
<br />
183185

184186
### Deactivate / Remove Deployment Environment (also from settings)
187+
185188
The example below will be triggered on a delete event.
186189
- ✔️ Deactivates deployment
187190
- ✔️ Removes from deployments tab
@@ -486,6 +489,7 @@ curl -I -L -H "Accept: application/vnd.github+json" -H "Authorization: Bearer <Y
486489
<br />
487490

488491
You will see:
492+
489493
```console
490494
x-github-api-version-selected: 2022-11-28
491495
X-RateLimit-Limit: 10000
@@ -504,6 +508,7 @@ X-RateLimit-Resource: core
504508
<br />
505509

506510
## Build & Release
511+
507512
To build a new copy of this workflow for development:
508513

509514
<br />
@@ -517,6 +522,7 @@ npm install
517522
<br />
518523

519524
### New Github Release
525+
520526
To push a new release, first run eslint locally to check for issues
521527
```shell
522528
npm run lint
@@ -543,6 +549,7 @@ Once you run the publish workflow, a second workflow will be ran: `.github\workf
543549
<br />
544550

545551
#### Call With Version Number
552+
546553
This example shows how to use the workflow using the version number:
547554

548555
```yml

0 commit comments

Comments
 (0)