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
Release Notes JSON Description Field #3829
Release Notes JSON Description Field #3829
Conversation
Gatsby Cloud Build Reportdocs-website-develop 🎉 Your build was successful! See the Deploy preview here. Build Details🕐 Build time: 40m |
Hey, @jpvajda! Could you have a look at this? Thanks! |
I'm going to see if @roadlittledawn can review as well. It looks good to me, but he did some work on this part of the site so wanted another set of 👀 on it. Thanks for the contribution @x8a and @cade-conklin |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looks good to me!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The first time I ran this my environment crashed, but every other time this has worked well, so I'm chalking it up to something on my end 🎉
Give us some context
The current release notes JSON return a JSON with fields: agent, version, and release date. One of our services relies on this JSON but needs a description field so that it can parse the release notes to determine the supportability for various agents. The change was very minor and involved adding an excerpt field to the GraphQL call. The length of each excerpt was arbitrarily set at 5000 assuming most release notes won't exceed that length. When running locally, this is what the new JSON will look like
Here is a link to the issue that was opened a while ago. The reason this was just now completed was that our team just now raised visibility on it again.
Are you making a change to site code?
Yes. This is a very small change!
If you're changing site code (rather than the content of a doc), please follow
conventional commit standards
in your commit messages and pull request title.