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

CHANGELOG.md creation #191

Merged
merged 5 commits into from
Nov 18, 2020
Merged

CHANGELOG.md creation #191

merged 5 commits into from
Nov 18, 2020

Conversation

sahithyandev
Copy link
Contributor

@sahithyandev sahithyandev commented Nov 18, 2020

Create CHANGELOG.md

Description

I wrote a node.js script that generates CHANGELOG.md from changelog.txt.
What the script does is.

  1. Read the changelog.txt
  2. Extract the data
  3. Make changes where needed
  4. Write the data to CHANGELOG.md

And also if you pass --generate-json as a CLI parameter to the script, it will write the extracted data to changelog-data.json.

Motivation and Context

In the changelog, contributors may want to refer to an issue or to a link which is related to a specific change. In plain text, it can be achievable, but markdown would be more suitable.

How Has This Been Tested?

I ran node generate-changelog.js and everything worked out as I expected.
The script created CHANGELOG.md using the content from changelog.txt

node: v12.19.0

Checklist

  • I have read the Contributing Guide
  • I read and accept the Code of Conduct (TLDR: just behave in a friendly manner)
  • My code follows the general style of this project
  • I have commented my code, particularly in hard-to-understand areas (I hope)
  • I have made corresponding changes to the documentation (if applicable)
  • I ensured that the automated checks that ran on this PR have completed successfully
  • I added myself to the package.json file (optional)

run generate-changelog.js to generate the MD file from changelog.txt
@Sv443 Sv443 changed the base branch from wip/2.2.3 to master November 18, 2020 11:47
@Sv443 Sv443 self-assigned this Nov 18, 2020
@Sv443 Sv443 added the enhancement New feature or request label Nov 18, 2020
@Sv443 Sv443 self-requested a review November 18, 2020 15:02
@Sv443 Sv443 merged commit b86bf6f into Sv443-Network:master Nov 18, 2020
@Sv443
Copy link
Member

Sv443 commented Nov 18, 2020

Thank you very much!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants