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

Add workflow to check milestone against current version #1610

Merged
merged 2 commits into from
Jan 22, 2025

Conversation

Isengo1989
Copy link
Collaborator

Problem

We do have some PRs that describe things that have yet to be released. Those are often marked with a version note but can be overseen. Also, our goal should be to describe only what has already been released.

Solution

This workflow checks all open PRs daily at X, and if a milestone is set (format -> v6.6.10.0), it compares it to the latest released version of shopware.

If the version does not match, it adds a blocked label to the PR.

If the version matches, it removes the blocked label and adds a comment mentioning the DX team.

Future Todos

If new features are described that are not released, a milestone should be set (either by developer or dx reviewer). As it is already standard for next releases.

@Isengo1989 Isengo1989 requested a review from Copilot December 12, 2024 13:38

Choose a reason for hiding this comment

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

Copilot reviewed 1 out of 1 changed files in this pull request and generated no suggestions.

@bojanrajh
Copy link
Collaborator

We did have cases where we wanted to update the docs before the next minor or major release (and we still could, because the label doesn't block us, it would just be a bit weird). Will there be a case where a PR has a "blocked" label and a "version" label, but shouldn't be released automatically (maybe it was targeted for that version but the docs are not ready yet)?

I'd rather go into direction of updating the default PR template and let the author decide when to merge the PR - once approved or once a specific minor/major version is released. Maybe with a new label "ready for a review" for a clearer assignment to the DX team?

@Isengo1989
Copy link
Collaborator Author

Isengo1989 commented Dec 16, 2024

We did have cases where we wanted to update the docs before the next minor or major release (and we still could, because the label doesn't block us, it would just be a bit weird). Will there be a case where a PR has a "blocked" label and a "version" label, but shouldn't be released automatically (maybe it was targeted for that version but the docs are not ready yet)?

I'd rather go into direction of updating the default PR template and let the author decide when to merge the PR - once approved or once a specific minor/major version is released. Maybe with a new label "ready for a review" for a clearer assignment to the DX team?

It is more of a tool to keep us up to date than to restrict a merge, which still can and possibly should happen.

Currently, it's also not a question of "let the author decide if we merge" since + 100 members can merge atm 👀

A new label will probably not do much if it is not bound to an automation or trigger.

On Wednesday, we can examine the standard we want to provide in terms of "readiness" and "outlook" for the developers more closely.

Readiness meaning: A feature is only released in docs, when it is released in shopware/shopware.

Outlook meaning: A feature is always released in docs, as soon as it is scheduled for a minor/patch (not major) and tagged with an version info inline.

@Isengo1989 Isengo1989 merged commit e94af40 into main Jan 22, 2025
8 checks passed
@Isengo1989 Isengo1989 deleted the dx-feature/check-milestone branch January 22, 2025 07:30
@Isengo1989
Copy link
Collaborator Author

Let's give it a go and disable / remove the workflow if not needed or brings too much overhead.

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