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.

Sign up for GitHub

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

Jump to bottom

[support-infra] Add release announcement to GitHub workflows #11867

Merged
merged 11 commits into from
Apr 3, 2024
Merged

[support-infra] Add release announcement to GitHub workflows #11867

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
6de4c20
adds release announcement to github workflows
michelengelen Jan 30, 2024
3606090
added a section into the README for the release and added the separat…
michelengelen Jan 30, 2024
ea02375
changed commit SHA on action
michelengelen Jan 30, 2024
ecbf889
make linter happy
michelengelen Jan 31, 2024
7b7e809
changed version SHA on action
michelengelen Jan 31, 2024
ed568e6
added avatar-url to action inputs
michelengelen Jan 31, 2024
9a72724
added permission reset
michelengelen Feb 7, 2024
a7af3f6
added link to logo in github repo
michelengelen Feb 8, 2024
c843c7f
Update scripts/releaseChangelog.mjs
michelengelen Feb 23, 2024
ce22355
changed separator string
michelengelen Feb 23, 2024
aca244c
Merge branch 'next' into automation/discord-release-announcement
michelengelen Apr 3, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
20 changes: 20 additions & 0 deletions .github/workflows/discord-release-announcement.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Discord Release Announcement

on:
release:
types: [prereleased, published]

michelengelen marked this conversation as resolved.
Show resolved Hide resolved
permissions: {}

jobs:
delimiter-test:
runs-on: ubuntu-latest
name: Send message to discord
steps:
- name: parse and send message
uses: michelengelen/discord-message-action@02af30a15955ecf718049bc33b0efabf6f626e0b
Copy link
Member

Choose a reason for hiding this comment

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

By the way, maybe we should review the action itself? Since it's the most essential part of the code.

Copy link
Member Author

Choose a reason for hiding this comment

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

Oh yes ... please go ahead. It's my private one, so nothing to hide there! :D

Copy link
Member Author

Choose a reason for hiding this comment

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

This is the link to it for reference: https://github.com/michelengelen/discord-message-action

Copy link
Member

Choose a reason for hiding this comment

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

I checked it - seems good. I think we can move forward and add this to the release workflow

with:
michelengelen marked this conversation as resolved.
Show resolved Hide resolved
webhook-url: ${{ secrets.DISCORD_WEBHOOK_URL }}
username: MUI Releases
avatar-url: 'https://raw.githubusercontent.com/mui/material-ui/master/docs/public/static/logo.png'
separator: '<!--/ HIGHLIGHT_ABOVE_SEPARATOR /-->'
6 changes: 5 additions & 1 deletion scripts/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,11 @@ yarn release:changelog
--release The branch to release (default: master)
```

You can also provide the GitHub token by setting `process.env.GITHUB_TOKEN` variable.
> :warning: the script will add a separator string in form of a comment like this right after the highlights:
> `<!--/ DO_NOT_REMOVE /-->`
> This string needs to stay where it gets inserted for the automated discord announcement to work.

You can also provide the github token by setting `process.env.GITHUB_TOKEN` variable.

In case of a problem, another method to generate the changelog is available at the end of this page.

Expand Down
2 changes: 2 additions & 0 deletions scripts/releaseChangelog.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,8 @@ We'd like to offer a big thanks to the ${
TODO INSERT HIGHLIGHTS
${changeLogMessages.length > 0 ? '\n\n' : ''}${changeLogMessages.join('\n')}

<!--/ HIGHLIGHT_ABOVE_SEPARATOR /-->

### Data Grid

#### \`@mui/x-data-grid@__VERSION__\`
Expand Down