Skip to content

Commit f822912

Browse files
committed
chore: update docs
1 parent 10b2602 commit f822912

File tree

2 files changed

+66
-1
lines changed

2 files changed

+66
-1
lines changed

.github/workflows/release-publish-tag-latest.yml

Lines changed: 37 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,42 @@
11
# #
22
# @type github workflow
3-
# @desc grabs the latest version of your github release, and creates an additional tag called @latest
3+
# @desc when making your own Github workflow, you must create two new releases.
4+
# 1. the version released
5+
# 2. one with the 'latest' tag
6+
#
7+
# this allows a user to use your workflow in a github yml file using either the version tag
8+
# or by using the latest tag.
9+
#
10+
# this workflow is triggered when you run the first workflow `release-publish.yml`.
11+
# this workflow runs after the first workflow has completed releasing the version tag v3.x.x,
12+
# and then this workflow will create a release with the tag 'latest' in your repo's 'Releases'
13+
# page on Github
14+
#
15+
# -------[ USING VERSION TAG ]-------------------------------------------------------------------
16+
#
17+
# jobs:
18+
# cleanup:
19+
# runs-on: ubuntu-latest
20+
# permissions: write-all
21+
#
22+
# steps:
23+
# - name: >-
24+
# ⚙️ Deployments › Clean
25+
# uses: Aetherinox/[email protected]
26+
# with:
27+
# token: ${{ secrets.SELF_TOKEN_CL }}
28+
# environment: orion
29+
# onlyRemoveDeployments: true
30+
# delay: "1000"
31+
#
32+
# -------[[ USING LATEST TAG ]--------------------------------------------------------------------
33+
#
34+
# steps:
35+
# - name: >-
36+
# ⚙️ Deployments › Clean
37+
# uses: Aetherinox/delete-deploy-env-action@latest
38+
#
39+
# grabs the latest version of your github release, and creates an additional tag called @latest
440
# useful for projects that involve creating github workflows that others can use.
541
# @author Aetherinox
642
# @url https://github.com/Aetherinox

README.md

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,8 @@ This github action allows you to delete environments, as well as delete your dep
5151
- [Build \& Release](#build--release)
5252
- [Install](#install)
5353
- [New Github Release](#new-github-release)
54+
- [Call With Version Number](#call-with-version-number)
55+
- [Call With Latest Tag](#call-with-latest-tag)
5456
- [Contributors ✨](#contributors-)
5557

5658

@@ -538,6 +540,33 @@ Run the workflow `release-publish.yml` from https://github.com/Aetherinox/delete
538540

539541
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:
540542

543+
<br />
544+
545+
#### Call With Version Number
546+
This example shows how to use the workflow using the version number:
547+
548+
```yml
549+
jobs:
550+
cleanup:
551+
runs-on: ubuntu-latest
552+
permissions: write-all
553+
554+
steps:
555+
- name: >-
556+
⚙️ Deployments › Clean
557+
uses: Aetherinox/[email protected]
558+
with:
559+
token: ${{ secrets.SELF_TOKEN_CL }}
560+
environment: orion
561+
onlyRemoveDeployments: true
562+
delay: "1000"
563+
```
564+
565+
<br />
566+
567+
#### Call With Latest Tag
568+
This example shows how to use the workflow using the `latest` tag:
569+
541570
```yml
542571
jobs:
543572
cleanup:

0 commit comments

Comments
 (0)