github-changelog-gen

Github changelog generator

Generate a changelog from a github milestone grouping issues using tags.

Install

npm install -g github-changelog-gen

Usage

# Basic(will use feature and bug for grouping labels)
gh-changelog-gen <milestone> --repo=<repo>

# Format markdown
gh-changelog-gen <milestone> --repo=<repo> --formatter=markdown

# Custom labels
gh-changelog-gen <milestone> --repo=<repo> --labels=epic,critical

Example(Simple)

Running the following command

gh-changelog-gen 6 --repo=Azure/BatchLabs

Generate the following

============================================================
                           0.6.0
============================================================

feature:

  - Show pool estimated pricing (#595)
  - Job graphs (#591)
  - Download a file group (#589)
  - Task configuration show output files (#587)
  - Should reconnect to python server automatically (#581)
  - File(s) picker inside file group (#571)
  - File group picker (#569)
  - Add option to delete a node (#554)
  - Allow delete a job with a pool if same id (#543)
  - NCJ file groups (#530)

bug:

  - Notification bug when rebooting/reimaging node in the heatmap (#600)
  - Fix crash when changing pool graph history length (#585)
  - Show the resizing arrow only if the pool is resizing or has a resize error. (#583)
  - Connect to node add user as admin doesn't set it admin (#572)
  - Unknown validation issue for creating pool with "cloud service" (#563)
  - Heatmap not showing running task when too many nodes and maxTaskPerNode is high (#555)
  - Edit storage account needs to alter underlying observable (#539)
  - Open file on osx is broken (#534)
  - Downloading an encrypted output fails (#532)
  - navigating to a non-existent pool should show error/warning (#528)
  - Deleting 1 or more selected pools from quick-list has issues (#527)
  - bl-form-section has issues with step-index if subtitle too long (#525)
  - Delete items dialog has old buttons (#521)

other:

  - Prepare release 0.6.0 (#602)
  - Add V-Ray to the license picker (#566)
  - Add long running actions for the python rpc server so it doesn't timeout (#560)
  - Pass the AAD tokens to the python (#559)
  - Documentation fails to mention python version 3.6 or greater is required (#547)
  - Upgrade typescript to 2.4 (#540)
  - Investigate Batch Labs web view (#529)

Example(Markdown)

Running the following command

gh-changelog-generator 6 --repo=Azure/BatchLabs --formatter=markdown

Generate the following markdown

0.6.0

All items

feature:

• Show pool estimated pricing #595
• Job graphs #591
• Download a file group #589
• Task configuration show output files #587
• Should reconnect to python server automatically #581
• File(s) picker inside file group #571
• File group picker #569
• Add option to delete a node #554
• Allow delete a job with a pool if same id #543
• NCJ file groups #530

bug:

• Notification bug when rebooting/reimaging node in the heatmap #600
• Fix crash when changing pool graph history length #585
• Show the resizing arrow only if the pool is resizing or has a resize error. #583
• Connect to node add user as admin doesn't set it admin #572
• Unknown validation issue for creating pool with "cloud service" #563
• Heatmap not showing running task when too many nodes and maxTaskPerNode is high #555
• Edit storage account needs to alter underlying observable #539
• Open file on osx is broken #534
• Downloading an encrypted output fails #532
• navigating to a non-existent pool should show error/warning #528
• Deleting 1 or more selected pools from quick-list has issues #527
• bl-form-section has issues with step-index if subtitle too long #525
• Delete items dialog has old buttons #521

other:

• Prepare release 0.6.0 #602
• Add V-Ray to the license picker #566
• Add long running actions for the python rpc server so it doesn't timeout #560
• Pass the AAD tokens to the python #559
• Documentation fails to mention python version 3.6 or greater is required #547
• Upgrade typescript to 2.4 #540
• Investigate Batch Labs web view #529