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

docs(core): document the release process #682

Merged
merged 2 commits into from
Nov 6, 2024
Merged

Conversation

IvoGoman
Copy link
Contributor

Description

This introduces the description for the release process of Greenhouse. It follows a Release Flow-style approach where development and bug fixes are done on the main branch. In case of a release a new release branch will be created. Based on tags on the release branch, GitHub action are triggered to create a Draft Release including changelog and assets and upload the tagged Helm Chart and Container images.

Bugfixes will be done on the main branch and cherry-picked to the release branch based on PR comments.

What type of PR is this? (check all applicable)

  • 🍕 Feature
  • 🐛 Bug Fix
  • 📝 Documentation Update
  • 🎨 Style
  • 🧑‍💻 Code Refactor
  • 🔥 Performance Improvements
  • ✅ Test
  • 🤖 Build
  • 🔁 CI
  • 📦 Chore (Release)
  • ⏩ Revert

Related Tickets & Documents

Added tests?

  • 👍 yes
  • 🙅 no, because they aren't needed
  • 🙋 no, because I need help
  • Separate ticket for tests # (issue/pr)

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration

Added to documentation?

  • 📜 README.md
  • 🤝 Documentation pages updated
  • 🙅 no documentation needed
  • (if applicable) generated OpenAPI docs for CRD changes

Checklist

  • My code follows the style guidelines of this project
  • I have performed a self-review of my code
  • I have commented my code, particularly in hard-to-understand areas
  • I have made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • New and existing unit tests pass locally with my changes

@IvoGoman IvoGoman requested a review from a team as a code owner October 29, 2024 15:36
Copy link
Contributor

@uwe-mayer uwe-mayer left a comment

Choose a reason for hiding this comment

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

💯

straight forward!

RELEASE.md Outdated Show resolved Hide resolved
Co-authored-by: Uwe Mayer <[email protected]>
@IvoGoman IvoGoman changed the title docs(release): document the release process docs(core): document the release process Nov 6, 2024
@IvoGoman IvoGoman merged commit 35b1042 into main Nov 6, 2024
9 checks passed
@IvoGoman IvoGoman deleted the docs/releaseprocess branch November 6, 2024 12:29
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants