Skip to content

[FR] Add Versioning Processes to DR #4223

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
Merged
Mikaayenson merged 16 commits into from
Nov 6, 2024
Merged

[FR] Add Versioning Processes to DR #4223

Mikaayenson merged 16 commits into from
Nov 6, 2024

Conversation

@Mikaayenson
Copy link
Contributor

@Mikaayenson Mikaayenson commented Oct 31, 2024

Pull Request

Issue link(s): https://github.com/elastic/ia-trade-team/issues/471#issuecomment-2423259800

Summary - What I changed

  • Adds documentation on how we will version code changes
  • Adds a workflow that will create a draft release based on draft-releaser

How To Test

We will need to kick off a ci job (fake PR) once this merges to double check the workflow, since it only runs on main.

Checklist

  • Added a label for the type of pr: bug, enhancement, schema, 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

@Mikaayenson Mikaayenson self-assigned this Oct 31, 2024
@protectionsmachine
Copy link
Collaborator

protectionsmachine commented Oct 31, 2024

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.

Mikaayenson
Mikaayenson commented Oct 31, 2024
View reviewed changes
.github/release-drafter.yml Outdated
- title: 🐛 Bug Fixes
label: 'bug'
- title: 🛠 Internal Changes
label: 'internal'
Copy link
Contributor Author

@Mikaayenson Mikaayenson Oct 31, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

we can change this to whatever makes sense.

Copy link
Contributor

@shashank-elastic shashank-elastic Nov 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit Suggestion : Workflow Changes

@Mikaayenson Mikaayenson requested a review from w0rk3r October 31, 2024 21:18
traut
traut reviewed Oct 31, 2024
View reviewed changes
eric-forte-elastic
eric-forte-elastic reviewed Nov 4, 2024
View reviewed changes
terrancedejesus
terrancedejesus reviewed Nov 4, 2024
View reviewed changes
.github/workflows/version-code-and-release.yml Outdated
- name: Check for changes in kql, kibana, hunting, and etc
id: check_changes
run: |
CHANGED_FILES=$(git diff --name-only ${{ github.event.before }} ${{ github.sha }} | grep -E 'lib/kql|lib/kibana|detection_rules|tests|hunting|etc/' || echo "no-changes")
Copy link
Contributor

@terrancedejesus terrancedejesus Nov 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are intentionally skipping RTA. If so, I understand why.

Copy link
Contributor Author

@Mikaayenson Mikaayenson Nov 4, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

++ cortado

terrancedejesus
terrancedejesus approved these changes Nov 4, 2024
View reviewed changes
Copy link
Contributor

@terrancedejesus terrancedejesus left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Left some comments. LGTM

@Mikaayenson
Copy link
Contributor Author

Mikaayenson commented Nov 4, 2024

Note: The error on the drafter check is failing because the file release-drafter.yml is not yet on main.

Mikaayenson
Mikaayenson commented Nov 4, 2024
View reviewed changes
eric-forte-elastic
eric-forte-elastic approved these changes Nov 4, 2024
View reviewed changes
Copy link
Contributor

@eric-forte-elastic eric-forte-elastic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 Manual review, looks good to me! 👍

Mikaayenson
Mikaayenson commented Nov 5, 2024
View reviewed changes
@Mikaayenson Mikaayenson merged commit 77f42f1 into main Nov 6, 2024
12 checks passed
@Mikaayenson Mikaayenson deleted the 471-meta-dac-beta-feature-roadshow-webinar-conference-customer-discussion branch November 6, 2024 14:14
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
@Mikaayenson @github-actions
[FR] Add Versioning Processes to DR (#4223)
df735f1 
(cherry picked from commit 77f42f1)
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
@Mikaayenson @github-actions
[FR] Add Versioning Processes to DR (#4223)
385b366 
(cherry picked from commit 77f42f1)
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
@Mikaayenson @github-actions
[FR] Add Versioning Processes to DR (#4223)
64b2183 
(cherry picked from commit 77f42f1)
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
@Mikaayenson @github-actions
[FR] Add Versioning Processes to DR (#4223)
374247b 
(cherry picked from commit 77f42f1)
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
@Mikaayenson @github-actions
[FR] Add Versioning Processes to DR (#4223)
76dcfdd 
(cherry picked from commit 77f42f1)
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
@Mikaayenson @github-actions
[FR] Add Versioning Processes to DR (#4223)
68e0424 
(cherry picked from commit 77f42f1)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@traut traut traut approved these changes

@shashank-elastic shashank-elastic shashank-elastic approved these changes

@terrancedejesus terrancedejesus terrancedejesus approved these changes

@eric-forte-elastic eric-forte-elastic eric-forte-elastic approved these changes

@w0rk3r w0rk3r Awaiting requested review from w0rk3r

Assignees

@Mikaayenson Mikaayenson

Labels

backport: auto ci/cd enhancement New feature or request minor Team: TRADE

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

7 participants

@Mikaayenson @protectionsmachine @traut @shashank-elastic @terrancedejesus @eric-forte-elastic