@nona-creative/conventional-changelog-mobile-release-notes
    TypeScript icon, indicating that this package has built-in type declarations

    1.0.3 • Public • Published

    Conventional Changelog - Mobile Release Notes Preset

    A preset for use with conventional-changelog, which will output notes in a plain text format for use with Fastlane and Testflight or Google Play release notes.

    Table of Contents

    Purpose Of This Preset

    When deploying mobile applications to the Play Store or Testflight, it's often useful to generate the latest release notes as plain text, so that they can be supplied as part of the what to test next notes.

    This preset allows you to write these notes out to a file or files using conventional-changelog-cli, in plain text.

    Usage

    An example usage, after installing this package and conventional-changelog-cli could be:

    npx conventional-changelog -n ./node_modules/@nona-creative/conventional-changelog-mobile-release-notes  -o ./latest-release-notes.txt -r 2

    With this example, conventional-changelog-cli would write out latest-release-notes.txt with notes for the latest release to latest-release.txt with the following format.

    1.2.4 - (2021-07-08)
    
    Bug Fixes
    
    deps: update sdks
    
    1.2.3 - (2021-07-07)
    
    Bug Fixes
    
    env: fix android oauth client id
    
    1.2.2 - (2021-07-07)
    
    Bug Fixes
    
    sentry: switch to other sentry (#979)
    
    1.2.1 - (2021-07-05)
    
    Bug Fixes
    
    build: turn on proguard, adjust rules (#977)
    

    back to top

    Available Commands

    To see a list of available commands in this package when cloning the repo run:

    npm run help

    back to top

    Additional Docs

    back to top

    Quick Start For Development

    1. go through all the Prerequisites in Prerequisites
    2. npm i install NPM dependencies
    3. npm run code:build build the package

    back to top

    Testing

    We use Jest for testing. To run unit tests, you can use one of the following commands, to run once, run in watch mode, or to run all tests and generate converage reports.

    npm run test
    npm run test:watch

    back to top

    Install

    npm i @nona-creative/conventional-changelog-mobile-release-notes

    DownloadsWeekly Downloads

    26

    Version

    1.0.3

    License

    MIT

    Unpacked Size

    49.5 kB

    Total Files

    33

    Last publish

    Collaborators

    • yesitsdave
    • syntaxza
    • rollyourowned
    • neilrussell6
    • ian-cawood