November's Paddleball Marathon
    Wondering what’s next for npm?Check out our public roadmap! »

    lerna-changelog-gitlab

    1.0.3 • Public • Published

    lerna-changelog-gitlab

    Forked from lerna-changelog

    Everything is the name, expect it's integrated with Gitlab!

    Latest NPM release

    Gitlab PR-based changelog generator with monorepo support

    Install

    Install with yarn:

    yarn add lerna-changelog-gitlab --dev
    # or globally 
    yarn global add lerna-changelog-gitlab

    We're using yarn but you can use npm if you like:

    npm install --save-dev lerna-changelog-gitlab
    # or globally 
    npm install --global lerna-changelog-gitlab

    Usage

    $ lerna-changelog-gitlab
    ## Unreleased (2018-05-24)
     
    #### :bug: Bug Fix
    * [#198](https://github.com/my-org/my-repo/pull/198) Avoid an infinite loop ([@helpful-hacker](https://github.com/helpful-hacker))
     
    #### :house: Internal
    * [#183](https://github.com/my-org/my-repo/pull/183) Standardize error messages ([@careful-coder](https://github.com/careful-coder))
     
    #### Commiters: 2
    - Helpful Hacker ([@helpful-hacker](https://github.com/helpful-hacker))
    - [@careful-coder](https://github.com/careful-coder)

    By default lerna-changelog-gitlab will show all pull requests that have been merged since the latest tagged commit in the repository. That is however only true for pull requests with certain labels applied. The labels that are supported by default are:

    • breaking (💥 Breaking Change)
    • enhancement (🚀 Enhancement)
    • bug (🐛 Bug Fix)
    • documentation (📝 Documentation)
    • internal (🏠 Internal)

    You can also use the --from and --to options to view a different range of pull requests:

    lerna-changelog-gitlab --from=v1.0.0 --to=v2.0.0

    Monorepo support

    If you have a packages folder and your projects in subfolders of that folder lerna-changelog-gitlab will detect it and include the package names in the changelog for the relevant changes.

    GitHub Token

    Since lerna-changelog-gitlab interacts with the GitLab API you may run into rate limiting issues which can be resolved by supplying a "personal access token":

    export AUTH_TOKEN="..."
    

    You'll need a personal access token for the GitLab API with the read_repository scope for your private repositories.

    Configuration

    You can configure lerna-changelog-gitlab in various ways. The easiest way is by adding a changelog key to the package.json file of your project:

    {
      // ...
      "changelog": {
        "labels": {
          "feature": "New Feature",
          "bug": "Bug Fix"
        }
      }
    }

    The supported options are:

    • repo: Your "org/repo" on GitHub (automatically inferred from the package.json file)

    • nextVersion: Title for unreleased commits (e.g. Unreleased)

    • labels: GitHub PR labels mapped to changelog section headers

    • ignoreCommitters: List of committers to ignore (exact or partial match). Useful for example to ignore commits from bots.

    • cacheDir: Path to a GitHub API response cache to avoid throttling (e.g. .changelog)

    License

    lerna-changelog is released under the MIT License.

    Install

    npm i lerna-changelog-gitlab

    DownloadsWeekly Downloads

    0

    Version

    1.0.3

    License

    MIT

    Unpacked Size

    57.2 kB

    Total Files

    20

    Last publish

    Collaborators

    • avatar