Skip to content

Latest commit

 

History

History
295 lines (167 loc) · 7.58 KB

RELEASE-NOTES.md

File metadata and controls

295 lines (167 loc) · 7.58 KB

RELEASE NOTES

🚀 Release 1.7.0

2021-10-30

We have a new BRAND LOGO 🥳

⚡ Feat/customize notifications

2021-10-30

Changes

💅 Now you can customize your notifications!!

To do this you can configure a set of tag styles using notification.style configuration property like this

notification:
  style:
    h1:
      font-size: 3rem
      margin-top: 2rem
    h2:
      font-size: 2rem
      margin-top: 3rem

Issues

Close #67

🚀 Release 1.6.0

2021-10-21

⚡ Use last n releases

2021-10-21

Changes

New option to process las N releases is available!! 🥳

useLast: 2

Will use the creation date of the 2nd latest release to process pull requests

🐛 Move section decoration to config

2021-10-21

Changes

Release sections have not the required relevance as they are decorated with ## as any other issue.

To solve this we move section decorators # to configuration object, this allow users to configure as many # as they want.

🚀 Release 1.4.0

2021-10-19

⚡ Add since option to change start date filter

2021-10-19

Changes

  • Added since option to modify start date filter in pull requests query

🚀 Release 1.3.0

2021-10-18

Changes

  • Improve teams activity cards styles
  • Check for webhooks existence instead of publish flag to execute webhooks

🚀 Release 1.2.0

2021-10-18

Changes

✨ filter option is now available in configuration!

With this option you can add any filter you like in pull request query

filter: 'is:closed'

🚀 Release 1.1.3

2021-10-17

We need graphql-import-node to be installed in production

So we moved it from devDependencies to dependencies

🚀 Release 1.1.0

2021-10-17

This release will add some powerfull options like an asset pusher #27 and TEAMS notificator #15

⚡ Add teams webhook

2021-10-17

Changes

We are supporting teams notification!! 🥳 🥳

First configure webhooks in your TEAMS channel

Then edit your releasenotesrc

webhooks:
  teams:
    url: # <your webhook url>

⚡ Add assets publishment method

2021-10-17

Changes

Now publishment method can publish any file you specify under assets property.

assets:
    - CHANGELOG.md
    - package.json

This is usefull por CI workflows that require to update multiple files like increasing package version or updating changelog.

⚡ Add ignored labels option

2021-10-17

Changes

  • Added ignored labels option
ingoredLabels:
     - in-release-note

🚀 Release 1.0.0

2021-10-16

First package release! 🥳 🥳

We are glad to announce our first release version 1.0.0.

With this version you will be able to generate your own RELEASE-NOTES.md and share it with your users to give them a deep insight of what's in your latest release 🚀 !!

Configuration

We support .yml and .json formats with these options

Options Default Description
token GITHUB_TOKEN Authorization token. This will allow rng to access your repo!
repo GITHUB_REPOSITORY Repository name with user/repo format
out '.' Base path where RELEASE-NOTES will be generated
name RELEASE-NOTES Output file name
labels [ 'release-note' ] Only PRs with these labels will be used in generation process
split false If true one file will be generated per iteration, and will be stored under a release_notes folder in out directory
publish false If true the output file will be commited to repo
message chore: update RELEASE-NOTES Commit message
branch main Branch where output will be uploaded
title RELEASE NOTES Title used in output markdown
decoration Decoration object Icon decoration for each issue type

CLI

💻 You can use RNG in command-line with rng!

// rng --help

Comandos:
  bin.js generate  Generates Release Note markdown                  [alias: gen]
  bin.js publish   Pubish Release Note in your repo                 [alias: pub]

Opciones:
  --version  Muestra número de versión                                [booleano]
  --help     Muestra ayuda                                            [booleano]

There are two available commands generate and publish.

Generate
// rng generate --help

Generates Release Note markdown

Opciones:
      --version        Muestra número de versión                      [booleano]
      --help           Muestra ayuda                                  [booleano]
  -c, --configuration  Configuration file path            [cadena de caracteres]
  -o, --output, --out  Output path                        [cadena de caracteres]
  -n, --name           Output file name                   [cadena de caracteres]
  -a, --auth           Manual creadentials input                      [booleano]
  -r, --repo           Repo in format user/repo           [cadena de caracteres]
  -m, --message        Commit message                     [cadena de caracteres]
  -p, --publish        Publish output to your repo                    [booleano]
  -v, --verbose        Makes the script verbose                       [booleano]
  -i, --interactive    Executes interactive version of the script     [booleano]
Publish
// rng publish --help

Pubish Release Note in your repo

Opciones:
      --version        Muestra número de versión                      [booleano]
      --help           Muestra ayuda                                  [booleano]
  -c, --configuration  Configuration file path            [cadena de caracteres]
  -a, --auth           Manual creadentials input                      [booleano]
  -r, --repo           Repo in format user/repo           [cadena de caracteres]
  -m, --message        Commit message                     [cadena de caracteres]
  -p, --publish        Publish output to your repo                    [booleano]
  -v, --verbose        Makes the script verbose                       [booleano]
  -i, --interactive    Executes interactive version of the script     [booleano]

For more info take a look at our DOCS