Skip to content

Commit c4e11eb

Browse files
refactor: rename feature stop files to feature cleanup and update documentation
1 parent 2cc7145 commit c4e11eb

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -69,11 +69,11 @@ The deployment uses [deployer](https://deployer.org/) and [deployer-tools](https
6969
Includes:
7070
- `deploy/deploy-feature.yaml`
7171
- `deploy/deploy-feature-rollback.yaml`
72-
- `deploy/deploy-feature-stop.yaml`
73-
- `deploy/deploy-feature-downstream.yaml`
72+
- `deploy/deploy-feature-cleanup.yaml`
73+
- `deploy/deploy-feature-cleanup-downstream.yaml`
7474

7575
> [!NOTE]
76-
> The cleanup of a feature branch is a little bit tricky. It may happen that the branch has been deleted, triggering the `deploy:feature:stop` job. However, since the application code in the branch is no longer available at this point and the cleanup logic and configuration are therefore no longer present, the cleanup is delegated to another branch (usually the `main` branch) via the downstream pipeline.
76+
> The cleanup of a feature branch is a little bit tricky. It may happen that the branch has been deleted, triggering the `deploy:feature:cleanup` job. However, since the application code in the branch is no longer available at this point and the cleanup logic and configuration are therefore no longer present, the cleanup is delegated to another branch (usually the `main` branch) via the downstream pipeline.
7777

7878
### Prod Deployment
7979

deploy/deploy-feature-stop-downstream.yaml renamed to deploy/deploy-feature-cleanup-downstream.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Purpose:
2-
# Stop an existing feature branch instance on a staging system by calling a downstream pipeline on the main branch (Receiver)
2+
# Cleanup an existing feature branch instance on a staging system, called by a downstream pipeline on the main branch (Receiver)
33
#
4-
deploy:feature:stop:downstream:
4+
deploy:feature:cleanup:downstream:
55
stage: deploy.feature
66
extends:
77
- .ssh
Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
# Purpose:
2-
# Stop an existing feature branch instance on a staging system by calling a downstream pipeline on the main branch (Sender)
2+
# Cleanup an existing feature branch instance on a staging system by calling a downstream pipeline on the main branch (Sender)
33
#
4-
deploy:feature:stop:
4+
deploy:feature:cleanup:
55
stage: deploy.feature
66
extends:
77
- .ssh

0 commit comments

Comments
 (0)