feat(one-release-commit): create plugin with automation

Author: jBouyoud

README.md

@@ -69,6 +69,7 @@ Auto has an extensive plugin system and wide variety of official plugins. Make a
 - [microsoft-teams](./plugins/microsoft-teams) - Post your release notes to a Microsoft teams channel
 - [omit-commits](./plugins/omit-commits) - Ignore commits base on name, email, subject, labels, and username
 - [omit-release-notes](./plugins/omit-release-notes) - Ignore release notes in PRs made by certain accounts
+- [one-release-commit](./plugins/one-release-commit) - Allow to create a single release commit
 - [pr-body-labels](./plugins/pr-body-labels) - Allow outside contributors to indicate what semver label should be applied to the Pull Request
 - [released](./plugins/released) - Add a `released` label to published PRs, comment with the version it's included in and comment on the issues the PR closes
 - [s3](./plugins/s3) - Post your built artifacts to amazon s3

docs/pages/docs/configuration/plugins.mdx

@@ -17,8 +17,8 @@ If you don't configure plugins in your `.autorc` configuration file `auto` will
 - Installed through `npm` => uses [`npm`](../generated/npm)
 - Installed through executable => uses [`git-tag`](../generated/git-tag)
 
-For the majority of "package manager" plugins you should only use one at a time.
-Using multiple _will_ lead to undesired results.
+> :warning: For the majority of "package manager" plugins you should only use one at a time.
+> Using multiple _will_ lead to undesired results.
 
 ### No Plugins
 

plugins/one-release-commit/README.md

@@ -0,0 +1,24 @@
+# One-Release-Commit Plugin
+
+Allow to create a single release commit
+
+## Installation
+
+This plugin is not included with the `auto` CLI installed via NPM. To install:
+
+```bash
+npm i --save-dev @auto-it/one-release-commit
+# or
+yarn add -D @auto-it/one-release-commit
+```
+
+## Usage
+
+```json
+{
+  "plugins": [
+    "one-release-commit"
+    // other plugins
+  ]
+}
+```

plugins/one-release-commit/__tests__/one-release-commit.test.ts

@@ -0,0 +1,7 @@
+import Auto from '@auto-it/core';
+import OneReleaseCommit from '../src';
+
+describe('One-Release-Commit Plugin', () => {
+  test('should do something', async () => {
+  });
+});

plugins/one-release-commit/package.json

@@ -0,0 +1,44 @@
+{
+  "name": "@auto-it/one-release-commit",
+  "version": "10.34.2",
+  "main": "dist/index.js",
+  "description": "Allow to squash release commit in a single one",
+  "license": "MIT",
+  "author": {
+    "name": "Andrew Lisowski",
+    "email": "[email protected]"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org/",
+    "access": "public"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/intuit/auto"
+  },
+  "files": [
+    "dist"
+  ],
+  "keywords": [
+    "automation",
+    "semantic",
+    "release",
+    "github",
+    "labels",
+    "automated",
+    "continuos integration",
+    "changelog"
+  ],
+  "scripts": {
+    "build": "tsc -b",
+    "start": "npm run build -- -w",
+    "lint": "eslint src --ext .ts",
+    "test": "jest --maxWorkers=2 --config ../../package.json"
+  },
+  "dependencies": {
+    "@auto-it/core": "link:../../packages/core",
+    "fp-ts": "^2.5.3",
+    "io-ts": "^2.1.2",
+    "tslib": "1.10.0"
+  }
+}

plugins/one-release-commit/src/index.ts

@@ -0,0 +1,31 @@
+import { Auto, IPlugin, validatePluginConfiguration } from '@auto-it/core';
+import * as t from "io-ts";
+
+const pluginOptions = t.partial({
+});
+
+export type IOneReleaseCommitPluginOptions = t.TypeOf<typeof pluginOptions>;
+
+/** Allow to squash release commit in a single one */
+export default class OneReleaseCommitPlugin implements IPlugin {
+  /** The name of the plugin */
+  name = 'one-release-commit';
+
+  /** The options of the plugin */
+  readonly options: IOneReleaseCommitPluginOptions;
+
+  /** Initialize the plugin with it's options */
+  constructor(options: IOneReleaseCommitPluginOptions) {
+    this.options = options;
+  }
+
+  /** Tap into auto plugin points. */
+  apply(auto: Auto) {
+    auto.hooks.validateConfig.tapPromise(this.name, async (name, options) => {
+      // If it's a string thats valid config
+      if (name === this.name && typeof options !== "string") {
+        return validatePluginConfiguration(this.name, pluginOptions, options);
+      }
+    });
+  }
+}

plugins/one-release-commit/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "extends": "../../tsconfig.json",
+  "include": ["src/**/*", "../../typings/**/*"],
+
+  "compilerOptions": {
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "composite": true
+  },
+
+  "references": [
+    {
+      "path": "../../packages/core"
+    }
+  ]
+}

tsconfig.dev.json

@@ -91,6 +91,9 @@
     },
     {
       "path": "plugins/sbt"
+    },
+    {
+      "path": "plugins/one-release-commit"
     }
   ]
-}
+}