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

Update release guide #192

Merged
merged 7 commits into from
Feb 16, 2024
Merged

Update release guide #192

merged 7 commits into from
Feb 16, 2024

Conversation

IshaanDesai
Copy link
Member

@IshaanDesai IshaanDesai commented Feb 6, 2024

During the release of v3.0.0.0, I noticed that some instructions in the release guide are not easy to follow and a bit confusing. I reordered some things and also moved the pre-releasing points into their own section.

For reviewing, it would make sense if one directly reads the new release guide and tries to gauge the flow of the document.

@IshaanDesai IshaanDesai self-assigned this Feb 6, 2024
@IshaanDesai IshaanDesai added the documentation Improvements or additions to documentation label Feb 6, 2024
Copy link
Member

@BenjaminRodenberg BenjaminRodenberg left a comment

Choose a reason for hiding this comment

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

I think the pre-release workflow is still a bit strange: We should do the pre-release from the same branch and commit that should be used as a basis for the stable release in the future. Remember: We want to test the workflow of the actual release and should , therefore, stay as close to the actual release as possible.

I think some tweaking of 4. is necessary.

docs/ReleaseGuide.md Outdated Show resolved Hide resolved
docs/ReleaseGuide.md Outdated Show resolved Hide resolved
docs/ReleaseGuide.md Outdated Show resolved Hide resolved
docs/ReleaseGuide.md Outdated Show resolved Hide resolved
IshaanDesai and others added 5 commits February 7, 2024 10:26
Co-authored-by: Benjamin Rodenberg <benjamin.rodenberg@cit.tum.de>
Co-authored-by: Benjamin Rodenberg <benjamin.rodenberg@cit.tum.de>
Co-authored-by: Benjamin Rodenberg <benjamin.rodenberg@cit.tum.de>
@IshaanDesai
Copy link
Member Author

IshaanDesai commented Feb 7, 2024

@BenjaminRodenberg I reworded the pre-release part. Can you have a look once more?

@BenjaminRodenberg
Copy link
Member

Needs merge, but looks good to me 👍

@IshaanDesai IshaanDesai merged commit 7229cca into develop Feb 16, 2024
18 checks passed
@IshaanDesai IshaanDesai deleted the update-release-guide branch February 16, 2024 16:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants