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

Adds changelog to JS SDK. Adds script for automating update of change… #1045

Merged
merged 5 commits into from Jul 19, 2016

Conversation

LiuJoyceC
Copy link
Contributor

…log based on json files in .changes directory.

/cc @chrisradek

@coveralls
Copy link

coveralls commented Jul 6, 2016

Coverage Status

Coverage remained the same at 89.017% when pulling dcabbf5 on LiuJoyceC:changelog into 0f20de2 on aws:master.

@LiuJoyceC
Copy link
Contributor Author

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 + ': ' +
Copy link
Contributor

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/

@coveralls
Copy link

coveralls commented Jul 7, 2016

Coverage Status

Coverage remained the same at 89.017% when pulling 57eaf84 on LiuJoyceC:changelog into 0f20de2 on aws:master.

@LiuJoyceC
Copy link
Contributor Author

For now, service updates for releases will need to have JSON files manually created in the next-release directory along with the JSON files for PRs.

@coveralls
Copy link

coveralls commented Jul 8, 2016

Coverage Status

Coverage remained the same at 89.017% when pulling 38bc99a on LiuJoyceC:changelog into 9787eaa on aws:master.

@chrisradek
Copy link
Contributor

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.

@coveralls
Copy link

coveralls commented Jul 8, 2016

Coverage Status

Coverage remained the same at 89.017% when pulling d14d290 on LiuJoyceC:changelog into 9787eaa on aws:master.

@LiuJoyceC
Copy link
Contributor Author

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.

@coveralls
Copy link

coveralls commented Jul 8, 2016

Coverage Status

Coverage remained the same at 89.017% when pulling 2a74fe7 on LiuJoyceC:changelog into 9787eaa on aws:master.

@chrisradek
Copy link
Contributor

:shipit:

…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.
@coveralls
Copy link

coveralls commented Jul 18, 2016

Coverage Status

Coverage remained the same at 88.749% when pulling a9c8432 on LiuJoyceC:changelog into 8ba7874 on aws:master.

@LiuJoyceC LiuJoyceC merged commit 2e54f33 into aws:master Jul 19, 2016
chrisradek added a commit that referenced this pull request Jul 19, 2016
LiuJoyceC added a commit that referenced this pull request Jul 26, 2016
LiuJoyceC added a commit that referenced this pull request Jul 29, 2016
@lock
Copy link

lock bot commented Sep 28, 2019

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.

@lock lock bot locked as resolved and limited conversation to collaborators Sep 28, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants