Skip to content

Commit d81d5c7

Browse files
committed
CD workflow naming adjustments
1 parent d4ae3d5 commit d81d5c7

File tree

1 file changed

+7
-5
lines changed

1 file changed

+7
-5
lines changed

README.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,24 @@ GitHub action to deploy [StackStorm](https://stackstorm.com/) to an AWS VM (EC2)
2020

2121
## Example usage
2222

23-
Create a Github Action Workflow `.github/workflow/deploy.yaml` with the following to build on push to the `main` branch.
23+
Create a Github Action Workflow `.github/workflow/deploy-st2.yaml` with the following to build on push to the `main` branch.
2424

2525
```yaml
26-
name: Deploy ST2 Single VM with GHA
26+
# Deploy ST2 Single VM with GHA
27+
name: CD
2728

2829
on:
2930
push:
3031
branches: [ main ]
3132

3233
jobs:
33-
deploy:
34+
deploy-st2:
3435
runs-on: ubuntu-latest
3536
steps:
36-
- id: deploy
37+
- id: deploy-st2
3738
name: Deploy StackStorm
38-
# TODO: pin to the specific version (best practices)
39+
# NOTE: we recommend pinning to the latest numeric version
40+
# See: https://github.com/bitovi/github-actions-deploy-stackstorm/releases
3941
uses: bitovi/github-actions-deploy-stackstorm@main
4042
with:
4143
aws_default_region: us-east-1

0 commit comments

Comments
 (0)