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

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

Merged
18 changes: 18 additions & 0 deletions .github/workflows/discord-release-announcement.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
name: Discord Release Announcement

on:
release:
types: [prereleased, published]

michelengelen marked this conversation as resolved.
Show resolved Hide resolved
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.

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://i.ibb.co/YfMzb7r/logo.png'
danilo-leal marked this conversation as resolved.
Show resolved Hide resolved
separator: '<!--/ DO_NOT_REMOVE /-->'
4 changes: 4 additions & 0 deletions scripts/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,10 @@ yarn release:changelog
--release The branch to release (default: master)
```

> :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
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')}

<!--/ DO_NOT_REMOVE /-->
michelengelen marked this conversation as resolved.
Show resolved Hide resolved

### Data Grid

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