Skip to content

Commit 4459e87

Browse files
authored
Rename CICD workflows to be more descriptive (#328)
## Summary Rename CICD workflows to be more descriptive. I was getting confused with the meaning of each workflow based on the filename. Adopting a naming convention of `<artifact>-<workflow>` so that all the worflows related to the same artifact are next to each other (i.e. `cli` worfklows are together, `doc` workflows are together and so on) ## How was it tested? Can't test until I merge this PR
1 parent 9b4f923 commit 4459e87

File tree

5 files changed

+16
-9
lines changed

5 files changed

+16
-9
lines changed

.github/workflows/release.yml renamed to .github/workflows/cli-release.yml

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
name: release
1+
name: cli-release
2+
# Releases the Devbox CLI
23

3-
concurrency: deployment
4+
concurrency: cli-release
45

56
on:
67
# Build/Release on demand
@@ -23,7 +24,7 @@ permissions:
2324

2425
jobs:
2526
tests:
26-
uses: ./.github/workflows/tests.yaml
27+
uses: ./.github/workflows/cli-tests.yaml
2728

2829
prerelease:
2930
runs-on: ubuntu-latest

.github/workflows/tests.yaml renamed to .github/workflows/cli-tests.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
name: tests
1+
name: cli-tests
2+
# Runs the Devbox CLI tests
23

34
concurrency:
45
group: ${{ github.ref }}

.github/workflows/previews.yaml renamed to .github/workflows/docs-deploy-preview.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
1-
name: docs-preview
1+
name: docs-deploy-preview
2+
# Deploys a preview of the docs website using launchpad.
23

34
on:
45
push:
@@ -30,7 +31,7 @@ jobs:
3031
files: docs/app/docs
3132
config_file: docs/.markdownlint.yaml
3233

33-
deploy-to-preview:
34+
docs-deploy-preview:
3435
runs-on: ubuntu-latest
3536
needs: markdown-lint
3637
steps:

.github/workflows/deployment.yaml renamed to .github/workflows/docs-deploy-prod.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
name: docs-deployment
1+
name: docs-deploy-prod
2+
# Deploys the prod version of the docs website.
23

3-
concurrency: deployment
4+
concurrency: docs-deployment
45

56
on:
67
workflow_dispatch:

.github/workflows/release-extension.yaml renamed to .github/workflows/vscode-ext-release.yaml

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
1-
name: release-extension
1+
name: vscode-ext-release
2+
# Releases the Devbox VSCode extension to the marketplace
3+
4+
concurrency: vscode-ext-release
25

36
on: workflow_dispatch
47

0 commit comments

Comments
 (0)