Skip to content

Commit 082c8b9

Browse files
authored
docs: add a runbook to update AppInspect CLI Action (#251)
This PR adds a runbook to update AppInspect CLI Action.
1 parent 6dd311b commit 082c8b9

File tree

2 files changed

+37
-0
lines changed

2 files changed

+37
-0
lines changed

.licenserc.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24,3 +24,4 @@ header:
2424
- "README.md"
2525
- "LICENSE"
2626
- ".*"
27+
- "runbooks/"
Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
# Runbook to update splunk/appinspect-cli-action
2+
3+
Once Splunk AppInspect team releases AppInspect CLI - we need to make sure that everyone runs the latest version.
4+
5+
## Steps
6+
7+
### Merge splunk/appinspect-cli-action PR
8+
9+
- go to the PR [example](https://github.com/splunk/appinspect-cli-action/pull/127)
10+
- check [release notes](https://dev.splunk.com/enterprise/docs/relnotes/relnotes-appinspectcli/whatsnew/) for the new version add release notes link in the PR comment
11+
- make sure that the pipeline is green
12+
- if not - investigate why and report and issue to the AppInspect team
13+
- determine which version of `appinspect-cli-action` needs to be released based on the PR
14+
- if it is a bug fix - change "chore" to "fix" in the title of the PR and skip [update section](#update-splunkaddonfactory-workflow-addon-release)
15+
- if it is a new feature - change "chore" to "feat" in the title of the PR
16+
- get review from the team
17+
- "Squash and merge" the PR
18+
- wait for the release
19+
- make sure that the proper version of the action is released
20+
21+
### Update splunk/addonfactory-workflow-addon-release
22+
23+
- create a PR in this repository with a new version of the action ([example PR](https://github.com/splunk/addonfactory-workflow-addon-release/pull/247))
24+
- make sure that PR is towards `main` branch
25+
- make sure that the pipeline is green
26+
- attach a link to a test run of reusable workflow
27+
- get review from the team
28+
- "Squash and merge" the PR
29+
- backport this change to develop right away ([example PR](https://github.com/splunk/addonfactory-workflow-addon-release/pull/239))
30+
- create a PR from `main` to `develop`
31+
- get review from the team
32+
- "Merge pull request" the PR
33+
34+
### Notify teams
35+
36+
- notify development teams in #ta-engineering-dev-all Slack channel (look for the previous announcements to see the format)

0 commit comments

Comments
 (0)