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

[core] Improve release process docs #12977

Merged
merged 5 commits into from
May 3, 2024

Conversation

JCQuintas
Copy link
Member

  • Ensure script pushes a tag instead of branch
  • Added announce merge freeze
  • Added how to create changelog
  • Added instruction in case publish fails
  • Instruction on which package should be updated vs not. Codemod? Package without changes?
  • Note about announcement, is it optional? When do we send and announcement?

@JCQuintas JCQuintas self-assigned this May 2, 2024
@JCQuintas JCQuintas added the core Infrastructure work going on behind the scenes label May 2, 2024
@mui-bot
Copy link

mui-bot commented May 2, 2024

Deploy preview: https://deploy-preview-12977--material-ui-x.netlify.app/

Generated by 🚫 dangerJS against 3e36095

@LukasTy LukasTy changed the title Improve release process docs [core] Improve release process docs May 3, 2024
Copy link
Member

@LukasTy LukasTy left a comment

Choose a reason for hiding this comment

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

Nice improvement! 👍
Thank you for taking care of it. 💯 💙

Note about announcement, is it optional? When do we send and announcement?

I would agree that we should at least mark this section as optional.
Lately, it's mostly up to @noraleonte and @joserodolfofreitas to decide when do we want an announcement and it's generation is no longer taken care by the card-generator. 🤔

scripts/README.md Outdated Show resolved Hide resolved
scripts/releaseTag.mjs Outdated Show resolved Hide resolved
scripts/README.md Outdated Show resolved Hide resolved
@michelengelen
Copy link
Member

with the changes suggested by @LukasTy that is! ^^

JCQuintas and others added 3 commits May 3, 2024 10:53
Co-authored-by: Lukas <llukas.tyla@gmail.com>
Signed-off-by: Jose C Quintas Jr <juniorquintas@gmail.com>
Co-authored-by: Lukas <llukas.tyla@gmail.com>
Signed-off-by: Jose C Quintas Jr <juniorquintas@gmail.com>
Co-authored-by: Lukas <llukas.tyla@gmail.com>
Signed-off-by: Jose C Quintas Jr <juniorquintas@gmail.com>
@JCQuintas
Copy link
Member Author

I'll be merging this and setup a reminder to talk about the open points in the future, thanks for the input

@JCQuintas JCQuintas merged commit 02edab4 into mui:master May 3, 2024
17 checks passed
@JCQuintas JCQuintas deleted the release-process-docs branch May 3, 2024 13:12
joakimtveter pushed a commit to joakimtveter/mui-x that referenced this pull request Jun 6, 2024
Signed-off-by: Jose C Quintas Jr <juniorquintas@gmail.com>
Co-authored-by: Lukas <llukas.tyla@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Infrastructure work going on behind the scenes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants