Skip to content

Commit 46d0b10

Browse files
chore: release v4.16 (#256)
Customer-facing release notes: * feat: remove Firefox from ui tests (#228) * fix: remove artifact-registry (#226) * feat(release): addonfactory-packaging-toolkit-action removal (#230) * fix: move poetry lock --check to unit tests job (#245) * feat: remove ESCU tests from reusable workflow (#234) * Splunk AppInspect CLI Action update to v2.6 * fix: combining splunk versions for python3.9 matrix issues (#257) Test runs: * splunk/splunk-add-on-for-microsoft-sysmon#315 * splunk/splunk-add-on-for-google-workspace#545
2 parents bfc6713 + 0f691bb commit 46d0b10

File tree

10 files changed

+259
-577
lines changed

10 files changed

+259
-577
lines changed

.github/workflows/branch-test-release.yml

Lines changed: 0 additions & 24 deletions
This file was deleted.

.github/workflows/build-test-release.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ jobs:
2020
runs-on: ubuntu-latest
2121
steps:
2222
- uses: actions/checkout@v3
23-
- uses: apache/skywalking-eyes@v0.5.0
23+
- uses: apache/skywalking-eyes@v0.6.0
2424
env:
2525
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
2626

@@ -33,7 +33,7 @@ jobs:
3333
python-version: "3.7"
3434
- run: |
3535
bash <(curl https://raw.githubusercontent.com/rhysd/actionlint/v1.6.26/scripts/download-actionlint.bash)
36-
- uses: pre-commit/action@v3.0.0
36+
- uses: pre-commit/action@v3.0.1
3737

3838
publish:
3939
needs:

.github/workflows/reusable-build-test-release.yml

Lines changed: 216 additions & 463 deletions
Large diffs are not rendered by default.

.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/"

README.md

Lines changed: 1 addition & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Workflow defines jobs which perform security code scanning, execute different ty
1919
* test it
2020
* create a PR to the `main` branch
2121
* get all the approvals from the team
22-
* merge it using "merge commit" option
22+
* merge it using "squash commit" option
2323
* backport the change back to the `develop` branch
2424
* new version of the workflow is going to be released (v4.17.0 (before) -> v4.17.1 (after)) and it will automatically applied to all the repositories
2525

@@ -411,30 +411,6 @@ appinspect-api-html-report-self-service
411411

412412
**Action used:** NA
413413

414-
# artifact-registry
415-
416-
**Description:**
417-
418-
- Uploads the generated addon build to ghcr.io.
419-
420-
**Action used:**
421-
422-
- https://github.com/actions/download-artifact
423-
- https://github.com/docker/setup-buildx-action
424-
- https://github.com/docker/login-action
425-
426-
**Artifacts:**
427-
428-
- No Artifacts
429-
430-
- This build can be downloaded using oras if it’s not availale in ghcr yet
431-
432-
- User can use the following command to download build for the respective PR
433-
434-
```
435-
oras pull -u <github-username> -p <github-token> ghcr.io/splunk/splunk-add-on-for-microsoft-sql-server:Splunk_TA_microsoft-sqlserver-<PR-no>
436-
```
437-
438414
# test-unit-python3
439415

440416
**Description:**
@@ -657,69 +633,6 @@ source_code.zip
657633
source_code.tar.gz
658634
```
659635

660-
Publish-untested (Publish a manual release):
661-
============================================
662-
663-
**NOTE:** This stage will create a new release with the main branch code irrespective of the test-execution status hence before creating a new release via this stage make sure all stakeholders are aware before the release.
664-
665-
- Follow the below steps to create a manual release and publish the relevant packages:
666-
667-
- Go to "Actions" tab of your Github repo link.
668-
669-
- On the left side, you'd have **"publish-untested"** workflow mentioned. Click on this stage.
670-
671-
- Click on **"Run Workflow"**.
672-
673-
- Select the branch from which you to create the tag.
674-
675-
- Ideally, all our final code would be in the main branch. Hence, in majority of cases the branch would be "main" only.
676-
677-
- Provide the version in "Tag to release" textbox.
678-
679-
- Example, if you are releasing a new version v4.0.1 of your add-on, just enter **"4.0.1"** (just the dot delimited digits, do not prefix it with "v").
680-
681-
- Click on **"Run Workflow"**.
682-
683-
- Wait for a couple minutes for the build to be generated and published.
684-
685-
- Once the above stage completes, go to "Releases" section of your repo.
686-
687-
- Edit the release and write the relevant release notes you want to for your bugfix/ hotfix release and save the changes.
688-
689-
<img src="images/publish-untested/publish-untested.png" alt="publish-untested" style="width:200px;"/>
690-
691-
692-
release-set-git-tags
693-
====================
694-
**Description**
695-
696-
- This action updates major/minor release tags on a tag push. e.g. Update v1 and v1.2 tag when released v1.2.3.
697-
698-
**Action used** https://github.com/haya14busa/action-update-semver
699-
700-
701-
Artifacts for different stages:
702-
================================
703-
704-
- Artifacts can be found in the summary if we scroll to the bottom as shown in the screenshot below. <br />
705-
<img src="images/artifacts_all.png" alt="publish-untested" style="width:200px;"/>
706-
707-
- Link to the test-report for the stage can be found inside logs as shown here:
708-
709-
<img src="images/modinput/report_link.png" alt="report_link" style="width:200px;"/>
710-
<img src="images/modinput/report_stage.png" alt="report_stage" style="width:200px;"/>
711-
712-
713-
Different Test reports stages
714-
=============================
715-
- addonfactory-sample-scanner
716-
- splunk 8.x.y knowledge test report
717-
- splunk 8.x.y modinput_functional test report
718-
- splunk 8.x.y ui chrome test report
719-
- splunk 8.x.y requirement_test test report
720-
- splunk 8.x.y unit test report
721-
722-
723636
Vendor Addon Matrix tests
724637
=========================
725638

images/artifacts_all.png

-787 KB
Binary file not shown.

images/modinput/report_link.png

-839 KB
Binary file not shown.

images/modinput/report_stage.png

-804 KB
Binary file not shown.
-556 KB
Binary file not shown.
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
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 [splunk-appinspect release](https://dev.splunk.com/enterprise/docs/relnotes/relnotes-appinspectcli/whatsnew/)
14+
- if it is a bug fix release (E.g. v3.6.0 > v3.6.1) - change "chore" to "fix" in the title of the PR and skip [update section](#update-splunkaddonfactory-workflow-addon-release)
15+
- if it is a minor release (E.g v3.6.0 > v3.7.0) - 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+
- determine which version of `appinspect-cli-action` needs to be released based on the PR
27+
- if it is a bug fix or dependecnies update - "fix" in the title of the PR
28+
- if it is a feature release - "feat" in the title of the PR
29+
- attach a link to a test run of reusable workflow
30+
- get review from the team
31+
- "Squash and merge" the PR
32+
- backport this change to develop right away ([example PR](https://github.com/splunk/addonfactory-workflow-addon-release/pull/239))
33+
- create a PR from `main` to `develop`
34+
- get review from the team
35+
- "Merge pull request" the PR
36+
37+
### Notify teams
38+
39+
- notify development teams in #ta-engineering-dev-all Slack channel (look for the previous announcements to see the format)

0 commit comments

Comments
 (0)