Skip to content

chore: add script for automatic changelog generation #5152

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

Merged
merged 1 commit into from
Nov 21, 2019

Conversation

rosen-vladimirov
Copy link
Contributor

@rosen-vladimirov rosen-vladimirov commented Nov 21, 2019

Add script to generate the changelog automatically. The script should be called from the root of the repository in the following way:

node generate_changelog.js <milestone> <GitHub Access Token which has read access to repository>

For example:

node generate_changelog.js 6.2.2 2d2156c261bb1494f7a6e22f11fa446c7ca0e6b7

The script uses GitHub's GraphQL API v4. More information about it can be found here.
The script is designed to work with current NativeScript CLI workflow:

  • it generates changelog based on CLI's Changelog.md format
  • it generates changelog only for issues, PR's added in the milestone are not included in the changelog
  • issues with no-changelog label are not added to the milestone. A warning is shown for them.
  • issues with feature label are added to the "New" section of the changelog. All other issues are added to the "Fixed" section.
  • issues, which are not in state "Ready for Test", "In testing" or "Done" are not added to the changelog. A warning is shown for them.

Add script to generate the changelog automatically. The script should be called from the root of the repository in the following way:
```
node generate_changelog.js <milestone> <GitHub Access Token which has read access to repository>
```

For example:
```
node generate_changelog.js 6.2.2 2d2156c261bb1494f7a6e22f11fa446c7ca0e6b7
```

The script uses GitHub's GraphQL API v4. More information about it can be found [here](https://developer.github.com/v4/).
The script is designed to work with current NativeScript CLI workflow:
 - it generates changelog based on CLI's Changelog.md format
 - it generates changelog only for issues, PR's added in the milestone are not included in the changelog
 - issues with no-changelog label are not added to the milestone. A warning is shown for them.
 - issues with feature label are added to the "New" section of the changelog. All other issues are added to the "Fixed" section.
 - issues, which are not in state "Ready for Test", "In testing" or "Done" are not added to the changelog. A warning is shown for them.
@rosen-vladimirov rosen-vladimirov self-assigned this Nov 21, 2019
@cla-bot cla-bot bot added the cla: yes label Nov 21, 2019
@rosen-vladimirov rosen-vladimirov merged commit 78f8f0e into release Nov 21, 2019
@rosen-vladimirov rosen-vladimirov deleted the vladimirov/automate-changelog-generation branch November 21, 2019 11:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants