@invisible/release-note

    2.1.2 • Public • Published

    This package is deprecated and will no longer be maintained. Use @invisible/changelog-update instead.

    @invisible/release-note

    CircleCI

    Provides three helper methods to publish the latest additions to your changelog.

    assert-release-note

    Asserts if there is an addition to your changelog in the current Pull Request.

    push-release-note

    Pushes the changelog additions to Slack (more adapters will be added in the future).

    last-changelog-additions

    Logs the latest changelog additions to stdout. If you are on master, looks at the diff from two merges ago. If you are not on master, looks at the diff between master and HEAD

    Install

    1. Install the package as devDependency:
    yarn add -D @invisible/release-note
    # or 
    npm install -D @invisible/release-note
    1. If you wish to use the push-release-note method, set up a Slack Webhook. NOTE: Slack will reject mutliple POST's to the same webhook that have identical messages, so you might run into this while testing.

    Usage

    Programmatically

      'use strict'
     
      const {
        assertReleaseNote,
        lastChangelogAdditions,
        pushReleaseNote,
      } = require('@invisible/release-note')
     
      // changelogFile defaults to CHANGELOG.md if no argument given
      // This method will throw if no addition has been made to your changelogFile since
      // the last merge commit
      assertReleaseNote({ changelogFile: 'CHANGELOG.txt' })
     
      const webhookUrl = process.env.CHANGELOG_WEBHOOK_URL
     
      // This method is async so it returns a promise that resolves the Response object from POST'ing to the Slack webhook
      pushReleaseNote({
        changelogFile: 'CHANGELOG.txt', // defaults to CHANGELOG.md
        iconEmoji: 'joy', // defaults to :robot_face:
        slackbotName: 'Cool Bot Name' , // defaults to Changelog
        webhookUrl,
      }).then(console.log).catch(console.error)
     
      const notes = lastChangelogAdditions()
     
      console.log(notes) // or do something cool with it

    Hook scripts

    assert-release-note

    1. Append assert-release-note to posttest on scripts section of your package.json.
      // It would look something like this:
      "scripts"{
        "posttest": "assert-release-note"
      }

    You can also run it at any time from your CLI.

    $ assert-release-note
    

    push-release-note

    1. Add to the deployment section of your project circle.yml file the following: - push-release-note
    # Your circle.yml should look like the below: 
    deployment:
      production:
        branch: master
        commands:
          - push-release-note

    You can also run it at any time from your CLI.

    $ push-release-note
    
    1. Optional: set a name for your slack bot and an icon emoji in your package.json
      "releaseNote": {
        "slackbotName": "Changelog Robot",
        "iconEmoji": "joy"
      }
    1. If using Circle CI, add the CHANGELOG_WEBHOOK_URL variable to your project. This package will optionally load dotenv if it's present, so you may add this to your .env file as well.

    TODO

    • Unit Tests
    • Testing on multiple platforms

    Install

    npm i @invisible/release-note

    DownloadsWeekly Downloads

    9

    Version

    2.1.2

    License

    MIT

    Last publish

    Collaborators

    • nadeeminv
    • gtaltemann
    • elseagle
    • keenahn
    • invisible-bot
    • rodrigo4244
    • pieterventer
    • scottdownes
    • zacksingh
    • el5091