@auto-it/all-contributors

All Contributors Plugin

Automatically add contributors as changelogs are produced.

This plugin maps one of the contribution type to a glob or array of globs. Out of the box the plugin will only detect the following contribution types:

• 📖 doc - Edits to any README, `['/*.mdx', '/.md', '/docs//', '/documentation//*']``
• 💡 example - Edits to ['**/*.stories*', '**/*.story.*']
• 🚇 infra - Edits to ['**/.circle/**/*', '**/.github/**/*', '**/travis.yml'],
• ⚠️ test - Edits to ['**/*.test.*']
• 💻 code - Edits to ['**/src/**/*', '**/lib/**/*', '**/package.json', '**/tsconfig.json']

Installation

This plugin is not included with the auto CLI installed via NPM. To install:

npx install-peerdeps --dev @auto-it/all-contributors

Prerequisites

You must have already installed and initialized all-contributors-cli;

npx all-contributors init

Usage

{
  "plugins": ["all-contributors"]
}

Configure Contribution Type Matching

You use any of the contribution type. If you configure an pre-configured contribution type the arrays are not merged, it is overridden.

auto.rc

{
  "plugins": [
    [
      "all-contributors",
      {
        "types": {
          "plugin": "**/plugin/**/*",
          "example": ["**/*.stories.*", "**/*.examples.*", "**/*.snippet.*"]
        }
      }
    ]
  ]
}

Exclude Users

Useful for excluding bots from getting into your contributors.

auto.rc

{
  "plugins": [
    [
      "all-contributors",
      {
        "exclude": ["dependabot", "ci-services"]
      }
    ]
  ]
}

Changelog

v7.13.1 (Thu Nov 07 2019)

🐛 Bug Fix

• @auto-it/npm
  • Fix GitHub Release's release notes for monorepo during shipit #663 (@hipstersmoothie)

Authors: 1

• Andrew Lisowski (@hipstersmoothie)

---