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] Update the release versioning process and workflow #4257

Merged
merged 5 commits into from
Nov 7, 2024

Conversation

Mikaayenson
Copy link
Contributor

Pull Request

Issue link(s):

Summary - What I changed

  • Now tags independently on all code changes (instead of waiting on the release workflow), to preserve proper versions. This prevents issues where our code base and tags can get out of sync.
  • Updates versioning docs

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

@protectionsmachine
Copy link
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.

echo "Detected version: $version"
git tag -a "v$version" -m "Release version $version"
git push origin "v$version"

- name: Run Release Drafter
Copy link
Contributor Author

Choose a reason for hiding this comment

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

@traut was going to gate this behind only major/minor tags, but since its only generating a draft, I now dont think we need to.

Copy link
Contributor

@shashank-elastic shashank-elastic left a comment

Choose a reason for hiding this comment

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

Changes discussed on discussion call, looks good

@eric-forte-elastic
Copy link
Contributor

Just typing the process as I see it to confirm, I think the output of the update will create a tag on any version change to the root pyproject.toml, and as such the prior release pipeline will function as intended, rather this will address the issue where our tags would not match the pyproject.toml on the draft releases that were created.

Good peer review, LGTM 👍

Copy link

@traut traut left a comment

Choose a reason for hiding this comment

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

let's go!

@Mikaayenson Mikaayenson merged commit c615df6 into main Nov 7, 2024
12 checks passed
@Mikaayenson Mikaayenson deleted the update_versioning_workflow branch November 7, 2024 17:31
protectionsmachine pushed a commit that referenced this pull request Nov 7, 2024
protectionsmachine pushed a commit that referenced this pull request Nov 7, 2024
protectionsmachine pushed a commit that referenced this pull request Nov 7, 2024
protectionsmachine pushed a commit that referenced this pull request Nov 7, 2024
protectionsmachine pushed a commit that referenced this pull request Nov 7, 2024
protectionsmachine pushed a commit that referenced this pull request Nov 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants