Skip to content
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.

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

[FR] DRAFT Release Workflow on PR Merge #4253

Merged
merged 2 commits into from
Nov 6, 2024
Merged

Conversation

Mikaayenson
Copy link
Contributor

@Mikaayenson Mikaayenson commented Nov 6, 2024

Pull Request

Issue link(s):

Summary - What I changed

  • We need to make sure the drafts are updated based on the context on the PR so that the labels influence the tagging.
  • Simplified the workflow to update the draft when the PR merges

How To Test

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

- main
paths:
- 'pyproject.toml'
types: [opened, reopened, synchronize, labeled, closed]
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
types: [opened, reopened, synchronize, labeled, closed]
types: [opened, reopened, synchronize, labeled]

Just double checking, are we sure we want closed?

Copy link
Contributor

Choose a reason for hiding this comment

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

Oh wait, we do want closed because we would want this check to run after a merge too right?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

yes thats for the last step.

@Mikaayenson Mikaayenson added the bug Something isn't working label Nov 6, 2024
@protectionsmachine
Copy link
Collaborator

Bug - Guidelines

These guidelines serve as a reminder set of considerations when addressing a bug in the code.

Documentation and Context

  • Provide detailed documentation (description, screenshots, reproducing the bug, etc.) of the bug if not already documented in an issue.
  • Include additional context or details about the problem.
  • Ensure the fix includes necessary updates to the release 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 bug fix or edge cases.
  • Existing unit tests have been updated to reflect the changes.
  • Provide evidence of testing and detecting the bug fix (e.g., test logs, screenshots).
  • Validate that any rules affected by the bug 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 bug fix does not break existing functionality.
  • Review the bug fix with a peer or team member for additional insights.
  • Verify that the bug fix 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.

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 changed the title [FR] Simplify the DRAFT Release Workflow [FR] DRAFT Release Workflow on PR Merge Nov 6, 2024
@Mikaayenson Mikaayenson merged commit c1ac8f0 into main Nov 6, 2024
41 of 45 checks passed
@Mikaayenson Mikaayenson deleted the update_release_workflow branch November 6, 2024 21:36
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
protectionsmachine pushed a commit that referenced this pull request Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants