Skip to content

Update release documentation#7

Open
johannes-graner wants to merge 1 commit into
mainfrom
docs/release
Open

Update release documentation#7
johannes-graner wants to merge 1 commit into
mainfrom
docs/release

Conversation

@johannes-graner

Copy link
Copy Markdown
Contributor

The current release documentation is vastly out of date, so I decided to update it and suggest a new release procedure.

@haakanpersson haakanpersson left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I am a bit confused about the workflow. Wouldn't it make more sense to test the release branch before merging into main? I am not comfortable with shipping potentially broken code into main.

If we decide to test before merging, the last step, "merge release tag back into main" would be redundant.

@johannes-graner

Copy link
Copy Markdown
Contributor Author

I agree that the last step is a bit redundant, we could probably skip that. It was mostly an attempt at making sure any fixes made for the release branch would be present in main as well.

Since there is no longer a super-stable main branch (main is the develop branch), it is not expected to always be completely bug-free, that can only be expected of the release tags.

See e.g. git flow vs. github flow for the difference I'm suggesting (old way: git flow, my proposal: github flow).

@haakanpersson

Copy link
Copy Markdown
Contributor

I skimmed through the blog post about git flow vs GitHub flow, and I agree that something like GitHub flow fits our purposes much better. But quoting from the blog post:

  • After the code review is passed or when the code review is ongoing, the branch must be deployed to the test environment for verification.

  • If the review and verification are passed, the code must be merged to the master branch. So, the master branch is always be deployable.

As I read it, we should still test before merging into main. Or am I missing something?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants