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
Adds changelog to JS SDK. Adds script for automating update of change… #1045
Conversation
I couldn't add the .changes directory yet because I can't commit an empty directory, but we can add it when the first changelog json is added. |
if (!change.type || !change.category || !change.description) { | ||
throw new Error('json not in correct format'); | ||
} | ||
entry += '\n\t<li>' + change.type + ': ' + change.category + ': ' + |
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.
Might want to use standard markdown instead of html:
https://guides.github.com/features/mastering-markdown/
For now, service updates for releases will need to have JSON files manually created in the |
Do you mind adding a README for these new scripts that explains what they do, or how they should be run? I know we don't expect these particular scripts to be run by users but it would still be helpful for future contributors. |
New changes have been pushed. The README contains a fictional example of an entry in the changelog that we should swap out for a real example when we create our first real entry. |
…log based on json files in .changes directory.
…on files in .changes/ directory. Modified update-changelog script to use markdown syntax rather than HTMl, and changed to use parseInt to convert numeric strings to numbers.
…il.js, modularized functionality of update-changelog to prevent duplicate logic and unnecessary reads and writes, which did not occur when update-changelog was first written as a standalone script but became a problem when the create-changelog and release scripts depended on it. All scripts relating to the changelog have been moved into its own subdirectory.
…nsertMarker and versionMarker rather than hard-coded
…ecks for errors. Logs message for each fs operation that modifies the filesystem.
This thread has been automatically locked since there has not been any recent activity after it was closed. Please open a new issue for related bugs and link to relevant comments in this thread. |
…log based on json files in .changes directory.
/cc @chrisradek