@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.12.4 (Tue Oct 29 2019)

🐛 Bug Fix

• @auto-it/released
  • Update released plugin message creation to replace all tokens #638 (@dependabot-preview[bot])

🔩 Dependency Updates

• Bump @typescript-eslint/eslint-plugin from 2.4.0 to 2.5.0 #636 (@dependabot-preview[bot])
• Bump @octokit/graphql from 4.2.2 to 4.3.0 #637 (@dependabot-preview[bot])
• Bump eslint-plugin-jest from 22.19.0 to 23.0.1 #634 (@dependabot-preview[bot] @hipstersmoothie)
• Bump command-line-application from 0.9.3 to 0.9.5 #635 (@dependabot-preview[bot])
• Bump @typescript-eslint/parser from 2.4.0 to 2.5.0 #633 (@dependabot-preview[bot])
• Bump https-proxy-agent from 3.0.0 to 3.0.1 #632 (@dependabot-preview[bot])
• Bump lerna from 3.18.1 to 3.18.3 #630 (@dependabot-preview[bot])
• Bump file-type from 12.3.0 to 12.3.1 #629 (@dependabot-preview[bot])
• Bump @types/semver from 6.0.2 to 6.2.0 #628 (@dependabot-preview[bot])
• @auto-it/core
  • Bump @octokit/rest from 16.33.1 to 16.34.0 #631 (@dependabot-preview[bot])

Authors: 2

• @dependabot-preview[bot]
• Andrew Lisowski (@hipstersmoothie)

---