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

chore: add a release roadmap #13677

Merged
merged 1 commit into from
Sep 22, 2024
Merged

Conversation

acolombier
Copy link
Member

@acolombier acolombier commented Sep 20, 2024

As new Mixxx contributor, I'm still struggling greatly with keeping track of the release schedule, so I thought I'd put together a document to keep track of our current release as well as the plan for future releases.

I tried a few Mermaid template, and this one seems to give the best visual. I'd be keen to get input on the data I have provisioned for future release, just to make sure I am in sync with the roadmap. These data will help with the milestone management. Note that we could also me this document to the wiki but I thought having it in the repo may make it more accessible and easier to keep in sync in the future.

Also removing an accidentally commited file

Tip

You might want to open the document to get the Mermaid diagram rendering

@acolombier acolombier force-pushed the chore/release-roadmap branch 2 times, most recently from 64a6dbd to f5038f1 Compare September 20, 2024 15:59
docs/roadmap.md Outdated
Comment on lines 31 to 34
2.5.x: Alpha (2023/01/11): Beta (2024/06/10): 2.5.0 (xxxx/xx/xx)
section Future releases
2.6.x: Alpha (2024/06/26): Beta (2024/12/01): 2.6.0 (xxxx/xx/xx)
2.7.x: Alpha (2024/12/01): Beta (2025/05/01): 2.6.0 (xxxx/xx/xx)
Copy link
Member Author

Choose a reason for hiding this comment

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

Ideally, I'd like to get the placeholder dates completed with prevision dates

docs/roadmap.md Outdated
Copy link
Member

Choose a reason for hiding this comment

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

We need to introduce the introduction of this new directory on zulip. Until now all dev-facing docs were handled exclusively on the wiki and this would start bifurcating that.

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'm happy to put that in the wiki!
I just thought I would open a PR so we can discuss this and I can use it to remove that dangling changelog backup

docs/roadmap.md Outdated
Comment on lines 26 to 27
2.2.x: 2.2.0 (2018/12/24): 2.2.1 (2019/04/22): 2.2.2 (2019/08/10): 2.2.3 (2019/11/26): 2.2.4 (2020/05/15): 2.2.4.1 (2021/02/17)
2.3.x: Beta (2020/05/12): 2.3.0 (2021/06/28): 2.3.1 (2021/09/29): 2.3.2 (2022/01/30): 2.3.3 (2022/06/21): 2.3.4 (2023/03/03): 2.3.5 (2023/05/10): 2.3.6 (2023/08/15)
Copy link
Member

Choose a reason for hiding this comment

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

whats the advantage of documenting this here when the same information is already visible in the appropriate github release or tag or milestone?

Copy link
Member Author

Choose a reason for hiding this comment

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

Not sure there is any advantage to be honest, I just thought it would make the timeline slightly easier to read but arguable we could truncate anything before the current release if you think this is just noise.

Copy link
Member

Choose a reason for hiding this comment

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

I like the idea to have this information more visible. Maybe also on our web page?

We have decided for this:
https://github.com/mixxxdj/mixxx/wiki/250_release_proposal#proposal-1-phase-model
But have failed to publish our decision appropriate.
Later we have also decided to set a release date every 6 month for orientation, while the "As long as it takes" has priority (quality over scheduled dates)

Make sure we keep the decision valid.

Is it possible to relate your diagram to the calendar date?
Something like this?
https://de.wikipedia.org/wiki/Ubuntu_(Betriebssystem)
This one is also interesting:
https://launchpad.net/mixxx

Copy link
Member Author

Choose a reason for hiding this comment

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

Maybe also on our web page?

I was thinking exactly that but not sure how the team would receive that document in general at first and also how Mermaid is supported in our web framework.

while the "As long as it takes" has priority (quality over scheduled dates)

100% makes sense. This is what I tried to capture in the info box:

> [!IMPORTANT]
> The date provided for the future release are purely indicative. The Mixxx Core Team reserves the right to adjust them in order to help with team availability and delays in tasks.

Can you think of a batter way to emphasise this point?

Is it possible to relate your diagram to the calendar date?

If you mean that diagram, I don't think Mermaid as any template for it, but I'll confirm that.

This one is also interesting:
https://launchpad.net/mixxx

Ah that's a bummer. I started making a branching diagram and decided to abandon the idea as it felt too convoluted. I will restart the idea so we can choose which one we prefer

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 couldn't find a way to make it look like your first example, but I was able to make something similar to the second. I don't find it very good, mainly due to Mermaid limitation, so I would suggest we keep the first one instead.

Copy link
Member

Choose a reason for hiding this comment

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

I don't have a strict preference here. Something is better than nothing. We can all the time improve it.

@acolombier acolombier force-pushed the chore/release-roadmap branch from 91330ad to 656f96f Compare September 21, 2024 23:35
@acolombier
Copy link
Member Author

acolombier commented Sep 21, 2024

Please note that the main part of the PR has now been moved as a website page. I have rebased the commits to remove the unwanted CHANGELOG.

Copy link
Member

@Swiftb0y Swiftb0y left a comment

Choose a reason for hiding this comment

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

LGTM. Thank you.

Copy link
Member

@daschuer daschuer left a comment

Choose a reason for hiding this comment

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

LGTM

@daschuer daschuer merged commit 2934ba7 into mixxxdj:main Sep 22, 2024
13 checks passed
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.

3 participants