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

change workflow documentation #1244

Merged
merged 4 commits into from
Dec 5, 2020
Merged

Conversation

rrsettgast
Copy link
Member

@rrsettgast rrsettgast commented Nov 30, 2020

changes the documentation for the git workflow to go with a simplified gitflow model.

@rrsettgast rrsettgast requested a review from corbett5 November 30, 2020 22:27
@rrsettgast rrsettgast force-pushed the docs/settgast/changeGitWorkflow branch from f190269 to 49cf43e Compare November 30, 2020 22:43
| |
| |
A----B----C----D----E----F-----G------------ (develop)
\ / \ / (tag v1.2.0)
Copy link
Contributor

Choose a reason for hiding this comment

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

The tags go on develop? I'm not sure it matters but I think it's easiest with a GitHub release to tag the actual release branch (release in this case).

Copy link
Member Author

Choose a reason for hiding this comment

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

Tags are related to commits, but we should tag commits from release branch even if they exist on develop.

Comment on lines 176 to 183
(tag v1.2.1) (tag v1.3.0)
A----B'---...-----G---------H'-----------J' (release)
^ ^\ / \ ^
| | \ / \ |
| | GA--GB \ | (hotfix)
| | \ |
A----B----...-----G--------------H---I---J (develop)
(tag v1.2.0)
Copy link
Contributor

Choose a reason for hiding this comment

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

Should not the hotfix branch go to both release and develop (starting from GB), while there should be no direct link from release to develop (H' to H)

Copy link
Member Author

Choose a reason for hiding this comment

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

I have modified the diagram to show a proper merge-back.

@CusiniM
Copy link
Collaborator

CusiniM commented Dec 3, 2020

Are we gonna run nightly tests on the release branch as well?

@corbett5
Copy link
Contributor

corbett5 commented Dec 3, 2020

Are we gonna run nightly tests on the release branch as well?

No, we shouldn't be changing it very often.

@rrsettgast rrsettgast merged commit f4dfd68 into develop Dec 5, 2020
@rrsettgast rrsettgast deleted the docs/settgast/changeGitWorkflow branch December 5, 2020 02:23
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.

4 participants