Skip to content

[Python] Ignore Hunting Doc Changes for Version Code Checks#4331

Merged
Aegrah merged 3 commits into
mainfrom
update-version-code-release-workflow-ignore-hunting-docs
Jan 7, 2025
Merged

[Python] Ignore Hunting Doc Changes for Version Code Checks#4331
Aegrah merged 3 commits into
mainfrom
update-version-code-release-workflow-ignore-hunting-docs

Conversation

@terrancedejesus
Copy link
Copy Markdown
Contributor

@terrancedejesus terrancedejesus commented Jan 6, 2025

Pull Request

Issue link(s): N/A

Summary - What I changed

Added an file path exclusion to the pull request triggers for workflow Version Code Check and Draft Release. This change will allow hunting pull requests to not require a patch version bump per new hunt added. As a reminder, hunting queries are developed and then the hunting CLI is used to convert the TOML to MD files. As such, **/*.md is matching for these changes and thus requiring versions to be bumped in the repo. It also matches on index.md which is updated every hunting PR to catalogue the new hunts.

How To Test

This has not been tested as it is a minor change, however, GitHub docs have been consulted to ensure formatting and sequential accuracy.

Checklist

  • Added a label for the type of pr: bug, enhancement, schema, maintenance, Rule: New, Rule: Deprecation, Rule: Tuning, Hunt: New, or Hunt: Tuning so guidelines can be generated
  • Added the meta:rapid-merge label if planning to merge within 24 hours
  • Secret and sensitive material has been managed correctly
  • Automated testing was updated or added to match the most common scenarios
  • Documentation and comments were added for features that require explanation

Contributor checklist

@terrancedejesus terrancedejesus added the python Internal python for the repository label Jan 6, 2025
@terrancedejesus terrancedejesus self-assigned this Jan 6, 2025
@terrancedejesus terrancedejesus added maintenance Internal changes enhancement New feature or request labels Jan 6, 2025
@protectionsmachine
Copy link
Copy Markdown
Collaborator

Enhancement - Guidelines

These guidelines serve as a reminder set of considerations when addressing adding a feature to the code.

Documentation and Context

  • Describe the feature enhancement in detail (alternative solutions, description of the solution, etc.) if not already documented in an issue.
  • Include additional context or screenshots.
  • Ensure the enhancement includes necessary updates to the documentation and versioning.

Code Standards and Practices

  • Code follows established design patterns within the repo and avoids duplication.
  • Code changes do not introduce new warnings or errors.
  • Variables and functions are well-named and descriptive.
  • Any unnecessary / commented-out code is removed.
  • Ensure that the code is modular and reusable where applicable.
  • Check for proper exception handling and messaging.

Testing

  • New unit tests have been added to cover the enhancement.
  • Existing unit tests have been updated to reflect the changes.
  • Provide evidence of testing and validating the enhancement (e.g., test logs, screenshots).
  • Validate that any rules affected by the enhancement are correctly updated.
  • Ensure that performance is not negatively impacted by the changes.
  • Verify that any release artifacts are properly generated and tested.

Additional Checks

  • Ensure that the enhancement does not break existing functionality.
  • Review the enhancement with a peer or team member for additional insights.
  • Verify that the enhancement works across all relevant environments (e.g., different OS versions).
  • Confirm that all dependencies are up-to-date and compatible with the changes.
  • Confirm that the proper version label is applied to the PR patch, minor, major.

@shashank-elastic
Copy link
Copy Markdown
Contributor

Originally was it intended to capture only code changes for hunting as a "version upgrade". Asking thins because hunting queries are not version controlled via normal release process, so just want to be sure before we exclude.

@Aegrah Aegrah merged commit 1a189a5 into main Jan 7, 2025
@Aegrah Aegrah deleted the update-version-code-release-workflow-ignore-hunting-docs branch January 7, 2025 11:54
protectionsmachine pushed a commit that referenced this pull request Jan 7, 2025
* Ignore hunting docs for version code checks

* added index.md to be ignored

---------

Co-authored-by: Ruben Groenewoud <78494512+Aegrah@users.noreply.github.com>

(cherry picked from commit 1a189a5)
protectionsmachine pushed a commit that referenced this pull request Jan 7, 2025
* Ignore hunting docs for version code checks

* added index.md to be ignored

---------

Co-authored-by: Ruben Groenewoud <78494512+Aegrah@users.noreply.github.com>

(cherry picked from commit 1a189a5)
protectionsmachine pushed a commit that referenced this pull request Jan 7, 2025
* Ignore hunting docs for version code checks

* added index.md to be ignored

---------

Co-authored-by: Ruben Groenewoud <78494512+Aegrah@users.noreply.github.com>

(cherry picked from commit 1a189a5)
protectionsmachine pushed a commit that referenced this pull request Jan 7, 2025
* Ignore hunting docs for version code checks

* added index.md to be ignored

---------

Co-authored-by: Ruben Groenewoud <78494512+Aegrah@users.noreply.github.com>

(cherry picked from commit 1a189a5)
protectionsmachine pushed a commit that referenced this pull request Jan 7, 2025
* Ignore hunting docs for version code checks

* added index.md to be ignored

---------

Co-authored-by: Ruben Groenewoud <78494512+Aegrah@users.noreply.github.com>

(cherry picked from commit 1a189a5)
protectionsmachine pushed a commit that referenced this pull request Jan 7, 2025
* Ignore hunting docs for version code checks

* added index.md to be ignored

---------

Co-authored-by: Ruben Groenewoud <78494512+Aegrah@users.noreply.github.com>

(cherry picked from commit 1a189a5)
@terrancedejesus
Copy link
Copy Markdown
Contributor Author

Originally was it intended to capture only code changes for hunting as a "version upgrade". Asking thins because hunting queries are not version controlled via normal release process, so just want to be sure before we exclude.

@shashank-elastic - apologies for your answer going unanswered. The hunting queries, at this time, are not product-driven and thus we did not add versioning to them intentionally as they are meant to serve the community. The TOML files are a foundational development step taken that may be important to future improvements or making these product-driven as originally we planned to just release MD docs.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backport: auto enhancement New feature or request maintenance Internal changes python Internal python for the repository

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants