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: outline the release cycle in depth #5214

Merged
merged 7 commits into from
Mar 6, 2023

Conversation

brianp
Copy link
Contributor

@brianp brianp commented Feb 28, 2023

Description

Outline in more detail how version tags are managed and the process of releasing a new tag for a particular channel and network.

Motivation and Context

Make sure everyones on the same page regarding tagging best practices, branching, and releasing.

How Has This Been Tested?

It will likely be read, and discussed.

@brianp brianp changed the title docs: Outline the release cycle in depth docs: outline the release cycle in depth Feb 28, 2023
docs/src/branching_releases.md Outdated Show resolved Hide resolved
docs/src/branching_releases.md Outdated Show resolved Hide resolved
docs/src/branching_releases.md Outdated Show resolved Hide resolved
@brianp
Copy link
Contributor Author

brianp commented Feb 28, 2023

This needs more disambiguation for what version numbers mean.

MAJOR being for hardforks
MINOR for breaking changes
PATCH for all other updates including hotfixes.


There's a notable difference here from a pattern we use now where we do not need to manage specific branches for master, stagenet, nextnet etc. Tags in the correct places should be sufficient, long lived branches for these channels don't serve much purpose in this process.

If we want to follow gitflow closer then we can reintroduce the maintenance of these branches by making every release branch merge into their channel specific branch. It's still worth noting that things only ever go into those branches, and hotfixes from them. No other work would be done on them. But also that's only if we actually wanted to maintain them.

@brianp brianp force-pushed the release-cycle branch 2 times, most recently from be690fe to 5dd5c32 Compare February 28, 2023 17:38
SWvheerden
SWvheerden previously approved these changes Mar 2, 2023
Copy link
Collaborator

@SWvheerden SWvheerden left a comment

Choose a reason for hiding this comment

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

ACK
Looks good I agree with the process

docs/src/branching_releases.md Outdated Show resolved Hide resolved
docs/src/branching_releases.md Outdated Show resolved Hide resolved
docs/src/branching_releases.md Outdated Show resolved Hide resolved
brianp and others added 7 commits March 6, 2023 14:17
Add an extra doc drafting the versioning semantics and how to release a
tag for any specific network.
Make sure the version pattern is explained so people know how to bump a
version when needed.
Hopefully it helps.
@brianp
Copy link
Contributor Author

brianp commented Mar 6, 2023

@stringhandler ready to go

@stringhandler stringhandler merged commit e4233b3 into tari-project:development Mar 6, 2023
@brianp brianp deleted the release-cycle branch October 2, 2023 14:31
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