Skip to content

Commit 85ad060

Browse files
committed
docs(readme): update instructions
1 parent f4423c8 commit 85ad060

File tree

1 file changed

+61
-0
lines changed

1 file changed

+61
-0
lines changed

README.md

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,9 @@ This github action allows you to delete environments, as well as delete your dep
4848
- [Avoid Secondary Rate Limiting](#avoid-secondary-rate-limiting)
4949
- [Limit Deployments Removed](#limit-deployments-removed)
5050
- [Rate Limits](#rate-limits)
51+
- [Build \& Release](#build--release)
52+
- [Install](#install)
53+
- [New Github Release](#new-github-release)
5154
- [Contributors ✨](#contributors-)
5255

5356

@@ -492,7 +495,65 @@ X-RateLimit-Resource: core
492495

493496
<br />
494497

498+
<br />
499+
500+
---
501+
502+
<br />
503+
504+
## Build & Release
505+
To build a new copy of this workflow for development:
506+
507+
<br />
508+
509+
### Install
510+
511+
```shell
512+
npm install
513+
```
514+
515+
<br />
516+
517+
### New Github Release
518+
To push a new release, first run eslint locally to check for issues
519+
```shell
520+
npm run lint
521+
```
522+
523+
<br />
495524

525+
Then open the `package.json` and bump the version. Then push the updated `package.json` file to the repo:
526+
```json
527+
{
528+
"name": "delete-deployment-environment",
529+
"version": "3.0.1",
530+
}
531+
```
532+
533+
<br />
534+
535+
Run the workflow `release-publish.yml` from https://github.com/Aetherinox/delete-deploy-env-action/actions.
536+
537+
<br />
538+
539+
Once you run the publish workflow, a second workflow will be ran: `.github\workflows\release-publish-tag-latest.yml`. This will create an additional new release with the tag `latest` so that you can use the workflow in your .yml file under the `latest` tag:
540+
541+
```yml
542+
jobs:
543+
cleanup:
544+
runs-on: ubuntu-latest
545+
permissions: write-all
546+
547+
steps:
548+
- name: >-
549+
⚙️ Deployments › Clean
550+
uses: Aetherinox/delete-deploy-env-action@latest
551+
with:
552+
token: ${{ secrets.SELF_TOKEN_CL }}
553+
environment: orion
554+
onlyRemoveDeployments: true
555+
delay: "1000"
556+
```
496557
497558
<br />
498559

0 commit comments

Comments
 (0)