Hey SDK team, it's time for some exciting new stuff! As you know, I've been working on a new unified developer changelog for on developer.box.com, and as part of this I've set up a workflow that will automatically import new GitHub Releases for this project into our developer changelog repository.
This pull request adds a new GitHub action workflow that will notify the changelog repository of any new GitHub releases when they happen. More details on how this automation works can be found in this section of the related repository: https://github.com/box/box-developer-changelog#automatic-contributions
Things we need to do now
Merge this pull request
Enable 3rd party GitHub actions in the GitHub actions tab for this repository. This will allow us to use the peter-evans/repository-dispatch@v1 action to send notifications across repositories.
Add a DISPATCH_ACCESS_TOKEN secret to the GitHub secrets for this repository. This allows us to act as @box-devrel when notifying across repositories. Please talk to me in Slack for this token.
How to make a new release?
Just keep making new releases as you always have, but maybe check out the documents below for some guidelines as to how to best write your markdown and best structure release notes.
Every time you make a new release:
This new workflow will trigger another workflow in the changelog GitHub repository
That second workflow will import the details for that release and create a new markdown file
A new Pull Request is then created in the changelog repo with that new file
If all linters and spell checks pass, the markdown file is automatically merged into our developer documentation.
If not, someone on the developer relations team will be notified of the new pull request and will make some manual changes to the entry.
An example of how this would work can be seen in this test release that was automatically merged.
Useful things to read next
As per multiple requests, we've put together some guidelines on how to write a great Release Note. For this reason, we've put together a few templates, as well as a markdown style guide.
A standard markdown template for release notes. This uses the format that we use within the changelog, but can be easily used for writing GitHub releases as well. Just make sure to drop the FrontMatter.
A short markdown template for when you rather have a short release note and point to a separate piece of documentation.
A markdown style guide that shows you how to write markdown that will pass our internal spell checkers and other linting.
Hey SDK team, it's time for some exciting new stuff! As you know, I've been working on a new unified developer changelog for on developer.box.com, and as part of this I've set up a workflow that will automatically import new GitHub Releases for this project into our developer changelog repository.
This pull request adds a new GitHub action workflow that will notify the changelog repository of any new GitHub releases when they happen. More details on how this automation works can be found in this section of the related repository: https://github.com/box/box-developer-changelog#automatic-contributions
Things we need to do now
peter-evans/repository-dispatch@v1action to send notifications across repositories.DISPATCH_ACCESS_TOKENsecret to the GitHub secrets for this repository. This allows us to act as @box-devrel when notifying across repositories. Please talk to me in Slack for this token.How to make a new release?
Just keep making new releases as you always have, but maybe check out the documents below for some guidelines as to how to best write your markdown and best structure release notes.
Every time you make a new release:
An example of how this would work can be seen in this test release that was automatically merged.
Useful things to read next
As per multiple requests, we've put together some guidelines on how to write a great Release Note. For this reason, we've put together a few templates, as well as a markdown style guide.
standardmarkdown template for release notes. This uses the format that we use within the changelog, but can be easily used for writing GitHub releases as well. Just make sure to drop the FrontMatter.shortmarkdown template for when you rather have a short release note and point to a separate piece of documentation.