Skip to content

fix: skip running tests on changes in validate-deploy-docs.yaml #420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 27 commits into
base: main
Choose a base branch
from
Open

fix: skip running tests on changes in validate-deploy-docs.yaml #420

wants to merge 27 commits into from

Conversation

siddharth-khatsuriya
Copy link
Contributor

Description

  • Since we now have a new validate-deploy-docs.yaml workflow for documentation, we are including it in the list of files considered as documentation-only changes. This ensures that test cases will not be triggered when only documentation workflows are modified. (ref)

Checklist

  • README.md has been updated or is not required
  • push trigger tests
  • manual release test
  • automated releases test
  • pull request trigger tests
  • schedule trigger tests
  • workflow errors/warnings reviewed and addressed

Testing done

(for each selected checkbox, the corresponding test results link should be listed here)

mgrandys-splunk and others added 27 commits March 6, 2025 11:37
@mgrandys-splunk
chore: run appinspect api on release branches (#376)
92a7bdf 
### Description
Run `appinspect api` job for `release/` branches in `build-test-release`
pipeline
Ticket: https://splunk.atlassian.net/browse/ADDON-77779

Tested in the following cases where appinspect api job is:
- Running for PR with “release/“ base:
https://github.com/splunk/splunk-add-on-for-microsoft-cloud-services/actions/runs/13626390125
- Running for manual trigger on “release/“ branch:
https://github.com/splunk/splunk-add-on-for-microsoft-cloud-services/actions/runs/13626413937
- Not running for chore/ branch:
https://github.com/splunk/splunk-add-on-for-microsoft-cloud-services/actions/runs/13626445165

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
(for each selected checkbox, the corresponding test results link should
be listed here)
@siddharth-khatsuriya
feat: skip tests on docs only change (#389)
8adf4a0 
### Description

[ [ADDON-78394](https://splunk.atlassian.net/browse/ADDON-78394) ] Added
conditions skip tests, build, app-inspect and publish if the changes in
PR are only related to documentation.

Tests:
https://docs.google.com/document/d/1IFxbIwzDM0lBkO3ciNxFrPlOPPE9YQhcaVStQg7lYEM/edit?usp=sharing

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
(for each selected checkbox, the corresponding test results link should
be listed here)
@siddharth-khatsuriya
feat: adding docs change validation step in reuseable CI (#390)
e30a821 
### Description

Added a new job validate-docs-change.
This job will attempt to serve the documentation and fail if there are
any errors.
If errors occur, they will be printed in the check logs step.

Another stage, enforce-docs-changes, reviews the result of
validate-docs-change and uses run metadata to determine whether the job
should fail the pipeline.

When the PR targets the main branch, enforce-docs-changes will enforce
failure on broken documentation and block merge.
For other branches, it serves as an indicator of documentation issues
without blocking the merge.

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
(for each selected checkbox, the corresponding test results link should
be listed here)
@dvarasani-crest @dkvashninsplunk
fix: hec token validation issue in scripted inputs (#393)
67b4168 
### Description
This PR bumps the k8s-manifests-branch version from v3.3.2 to v3.4.1
related PR:
splunk/ta-automation-k8s-manifests#120

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
-
https://github.com/splunk/splunk-add-on-for-unix-and-linux/actions/runs/14701563721

---------

Co-authored-by: Dmytro Kvashnin <dkvashnin@splunk.com>
@kdoroszko-splunk
docs: change the runbok for appinspect update (#395)
1f26798 
### Description

I think it makes more sense to make a fix release each time we update
appinspect version. We'd prevent ourselves from rolling out the template
each time there is a feat release of appinspect.

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
No tests are needed
@mkolasinski-splunk
Merge branch 'main' into develop
d30b057
@siddharth-khatsuriya
fix: update AppInspect CLI action to v2.10 (#394)
c54ceab 
### Description

update appinspect-cli-action to 2.10

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
(for each selected checkbox, the corresponding test results link should
be listed here)
@siddharth-khatsuriya @mkolasinski-splunk
@dkvashninsplunk @mgrandys-splunk @dvarasani-crest @kdoroszko-splunk
chore: sync main into develop after conflict resolution (#399)
bddfb2b 
###
The file `.github/workflows/reusable-build-test-release.yml` had merge
conflicts when merging develop into main.
This PR resolves those conflicts and syncs the changes accordingly.

---------

Co-authored-by: mkolasinski-splunk <105011638+mkolasinski-splunk@users.noreply.github.com>
Co-authored-by: Dmytro Kvashnin <dkvashnin@splunk.com>
Co-authored-by: Dmytro Kvashnin <139753462+dkvashninsplunk@users.noreply.github.com>
Co-authored-by: mgrandys-splunk <153620320+mgrandys-splunk@users.noreply.github.com>
Co-authored-by: dvarasani-crest <151819886+dvarasani-crest@users.noreply.github.com>
Co-authored-by: kdoroszko-splunk <kdoroszko@splunk.com>
@mgrandys-splunk @siddharth-khatsuriya
chore: run appinspect api on release branches (#376)
4c9a825 
### Description
Run `appinspect api` job for `release/` branches in `build-test-release`
pipeline
Ticket: https://splunk.atlassian.net/browse/ADDON-77779

Tested in the following cases where appinspect api job is:
- Running for PR with “release/“ base:
https://github.com/splunk/splunk-add-on-for-microsoft-cloud-services/actions/runs/13626390125
- Running for manual trigger on “release/“ branch:
https://github.com/splunk/splunk-add-on-for-microsoft-cloud-services/actions/runs/13626413937
- Not running for chore/ branch:
https://github.com/splunk/splunk-add-on-for-microsoft-cloud-services/actions/runs/13626445165

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
(for each selected checkbox, the corresponding test results link should
be listed here)
@siddharth-khatsuriya
feat: skip tests on docs only change (#389)
23c93f8 
### Description

[ [ADDON-78394](https://splunk.atlassian.net/browse/ADDON-78394) ] Added
conditions skip tests, build, app-inspect and publish if the changes in
PR are only related to documentation.

Tests:
https://docs.google.com/document/d/1IFxbIwzDM0lBkO3ciNxFrPlOPPE9YQhcaVStQg7lYEM/edit?usp=sharing

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
(for each selected checkbox, the corresponding test results link should
be listed here)
@siddharth-khatsuriya
feat: adding docs change validation step in reuseable CI (#390)
5e17b28 
### Description

Added a new job validate-docs-change.
This job will attempt to serve the documentation and fail if there are
any errors.
If errors occur, they will be printed in the check logs step.

Another stage, enforce-docs-changes, reviews the result of
validate-docs-change and uses run metadata to determine whether the job
should fail the pipeline.

When the PR targets the main branch, enforce-docs-changes will enforce
failure on broken documentation and block merge.
For other branches, it serves as an indicator of documentation issues
without blocking the merge.

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
(for each selected checkbox, the corresponding test results link should
be listed here)
@dvarasani-crest @dkvashninsplunk @siddharth-khatsuriya
fix: hec token validation issue in scripted inputs (#393)
cd697b4 
This PR bumps the k8s-manifests-branch version from v3.3.2 to v3.4.1
related PR:
splunk/ta-automation-k8s-manifests#120

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

-
https://github.com/splunk/splunk-add-on-for-unix-and-linux/actions/runs/14701563721

---------

Co-authored-by: Dmytro Kvashnin <dkvashnin@splunk.com>
@kdoroszko-splunk @siddharth-khatsuriya
docs: change the runbok for appinspect update (#395)
b93e398 
### Description

I think it makes more sense to make a fix release each time we update
appinspect version. We'd prevent ourselves from rolling out the template
each time there is a feat release of appinspect.

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
No tests are needed
@siddharth-khatsuriya
fix: update AppInspect CLI action to v2.10 (#394)
a8eb995 
### Description

update appinspect-cli-action to 2.10

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
(for each selected checkbox, the corresponding test results link should
be listed here)
@siddharth-khatsuriya @mkolasinski-splunk
@dkvashninsplunk @mgrandys-splunk @dvarasani-crest @kdoroszko-splunk
chore: sync main into develop after conflict resolution (#399)
e53353a 
###
The file `.github/workflows/reusable-build-test-release.yml` had merge
conflicts when merging develop into main.
This PR resolves those conflicts and syncs the changes accordingly.

---------

Co-authored-by: mkolasinski-splunk <105011638+mkolasinski-splunk@users.noreply.github.com>
Co-authored-by: Dmytro Kvashnin <dkvashnin@splunk.com>
Co-authored-by: Dmytro Kvashnin <139753462+dkvashninsplunk@users.noreply.github.com>
Co-authored-by: mgrandys-splunk <153620320+mgrandys-splunk@users.noreply.github.com>
Co-authored-by: dvarasani-crest <151819886+dvarasani-crest@users.noreply.github.com>
Co-authored-by: kdoroszko-splunk <kdoroszko@splunk.com>
@siddharth-khatsuriya @mkolasinski-splunk
@dkvashninsplunk @mgrandys-splunk @dvarasani-crest @kdoroszko-splunk
Chore/resolve conflicts (#400)
5843a59 
### Description

(PR description goes here)

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
(for each selected checkbox, the corresponding test results link should
be listed here)

---------

Co-authored-by: mkolasinski-splunk <105011638+mkolasinski-splunk@users.noreply.github.com>
Co-authored-by: Dmytro Kvashnin <dkvashnin@splunk.com>
Co-authored-by: Dmytro Kvashnin <139753462+dkvashninsplunk@users.noreply.github.com>
Co-authored-by: mgrandys-splunk <153620320+mgrandys-splunk@users.noreply.github.com>
Co-authored-by: dvarasani-crest <151819886+dvarasani-crest@users.noreply.github.com>
Co-authored-by: kdoroszko-splunk <kdoroszko@splunk.com>
@siddharth-khatsuriya
Revert "feat: adding docs change validation step in reuseable CI (#390)…
90cd8ec 
…" (#404)

This reverts commit e30a821.

### Description

This PR reverts the previous implementation of documentation validation
and enforcement, and reintroduces those capabilities using a **reusable
GitHub Actions workflow** along with a **template
`validate-deploy-docs.yml` workflow file** in the template repository.

## Changes with PR reference

- Removes the hardcoded docs validation logic.
- Changes related to document validation and deployment is made in this
PR: splunk/addonfactory-repository-template#743

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
(for each selected checkbox, the corresponding test results link should
be listed here)
@mkolasinski-splunk
chore: merge main to develop (#397)
1f14af1 
### Description

Update develop to be inline with main branch.

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
(for each selected checkbox, the corresponding test results link should
be listed here)
@dvarasani-crest
fix: update os versions for scripted input tests (#407)
f4d267f 
### Description
This PR removes the deprecated version (ubuntu 14.04) and add support of
Ubuntu 20.04 and redhat 9.5 for scripted inputs.

### Checklist

- [x] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [x] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
Test run:
https://github.com/splunk/splunk-add-on-for-unix-and-linux/actions/runs/15417614522
@siddharth-khatsuriya @harshilgajera-crest
@kdoroszko-splunk @mkolasinski-splunk @dkvashninsplunk @mgrandys-splunk @dvarasani-crest
Resolve merge conflict (#409)
f63c2cb 
### Description

Resolving develop -> main conflict

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
(for each selected checkbox, the corresponding test results link should
be listed here)

---------

Co-authored-by: harshilgajera-crest <69803385+harshilgajera-crest@users.noreply.github.com>
Co-authored-by: kdoroszko-splunk <kdoroszko@splunk.com>
Co-authored-by: mkolasinski-splunk <105011638+mkolasinski-splunk@users.noreply.github.com>
Co-authored-by: Dmytro Kvashnin <dkvashnin@splunk.com>
Co-authored-by: Dmytro Kvashnin <139753462+dkvashninsplunk@users.noreply.github.com>
Co-authored-by: mgrandys-splunk <153620320+mgrandys-splunk@users.noreply.github.com>
Co-authored-by: dvarasani-crest <151819886+dvarasani-crest@users.noreply.github.com>
@siddharth-khatsuriya
Merge branch 'main' of github.com:splunk/addonfactory-workflow-addon-…
c787ed4 
…release into main-dev-conflict
@siddharth-khatsuriya
Main dev conflict (#413)
53f181c 
### Description

(PR description goes here)

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
(for each selected checkbox, the corresponding test results link should
be listed here)
@siddharth-khatsuriya
chore: resolving review comments of dev to main pr (398) (#415)
8057ca3 
### Description

Resolving review comments of PR:
#398

- This PR addresses [this
comment](#398 (comment))
by removing redundant updates to both test-inventory and setup-workflow
for docs-only changes. Updating both is unnecessary since failure in
either prevents tests from running.
- Test runs:
https://github.com/splunk/splunk-add-on-for-amazon-web-services/actions/runs/15754544427/job/44407048288?pr=1486
- A few minor review comment changes were also made; they don't require
testing.

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
(for each selected checkbox, the corresponding test results link should
be listed here)
@mkolasinski-splunk
chore: merge main (#419)
eab87ea 
### Description

(PR description goes here)

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
(for each selected checkbox, the corresponding test results link should
be listed here)
@siddharth-khatsuriya
fix: skip running tests on changes in validate-deploy-docs.yaml (#416)
450dad0 
### Description
- Since we now have a new validate-deploy-docs.yaml workflow for
documentation, we are including it in the list of files considered as
documentation-only changes. This ensures that test cases will not be
triggered when only documentation workflows are modified.

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done for test addon repo

https://github.com/splunk/test-addonfactory-repo/actions/runs/15874408448/job/44758591172?pr=349
@siddharth-khatsuriya
Merge branch 'main' of github.com:splunk/addonfactory-workflow-addon-…
4232c41 
…release into res-conflict-dev
@siddharth-khatsuriya
chore: resolving conflict between develop and main (#422)
4b4407b 
### Description

(PR description goes here)

### Checklist

- [ ] `README.md` has been updated or is not required
- [ ] push trigger tests
- [ ] manual release test
- [ ] automated releases test
- [ ] pull request trigger tests
- [ ] schedule trigger tests
- [ ] workflow errors/warnings reviewed and addressed

### Testing done 
(for each selected checkbox, the corresponding test results link should
be listed here)
@siddharth-khatsuriya siddharth-khatsuriya marked this pull request as ready for review July 3, 2025 06:45
@siddharth-khatsuriya siddharth-khatsuriya requested a review from a team as a code owner July 3, 2025 06:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
No reviews
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
5 participants
@siddharth-khatsuriya @mgrandys-splunk @dvarasani-crest @kdoroszko-splunk @mkolasinski-splunk