Merge pull request #41 from woocommerce/add/assign-milestone-workflow

Add Assign Milestone Workflow

Author: mikejolley

.github/workflows/approved-automation.yml

@@ -0,0 +1,11 @@
+on: pull_request_review
+name: Add milestone when approved
+jobs:
+    milestoneWhenApproved:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v2
+            - uses: ./
+              with:
+                  github_token: ${{ secrets.GITHUB_TOKEN }}
+                  automations: assign-milestone

.prettierrc

@@ -0,0 +1,3 @@
+// Import the default config file and expose it in the project root.
+// Useful for editor integrations.
+module.exports = require( '@wordpress/prettier-config' );

.prettierrc.js

@@ -4,10 +4,11 @@ This is a [GitHub Action](https://help.github.com/en/categories/automating-your-
 
 ## Available Automations
 
-| Automation | Description |
-| ---- | --------------|
-| [todos](./lib/automations/todos/README.md) | This automation parses for `@todo` or `@TODO` comments in code and adds formatted pull request comments for each todo found. When a pull request is merged to the main branch, issues will be created for each `@todo` in the diff if there is not already an issue for that todo. |
-| [release](./lib/automations/release/README.md) | This automation handles automating various parts of a somewhat opinionated release process.
+| Automation                                                       | Description                                                                                                                                                                                                                                                                        |
+| ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [todos](./lib/automations/todos/README.md)                       | This automation parses for `@todo` or `@TODO` comments in code and adds formatted pull request comments for each todo found. When a pull request is merged to the main branch, issues will be created for each `@todo` in the diff if there is not already an issue for that todo. |
+| [release](./lib/automations/release/README.md)                   | This automation handles automating various parts of a somewhat opinionated release process.                                                                                                                                                                                        |
+| [assign-milestone](./lib/automations/assign-milestone/README.md) | This automation will assign the next milestone to a pull request once it has been approved.                                                                                                                                                                                        |
 
 ## Installation and Usage
 
@@ -16,22 +17,22 @@ To use the action, include it in your workflow configuration file:
 ```yaml
 on: pull_request
 jobs:
-  pull-request-automation:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: woocommerce/automations@v1
-        with:
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          # This can be a comma delimited list of automations to run, in this case we're just executing todos
-          automations: todos
+    pull-request-automation:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: woocommerce/automations@v1
+              with:
+                  github_token: ${{ secrets.GITHUB_TOKEN }}
+                  # This can be a comma delimited list of automations to run, in this case we're just executing todos
+                  automations: todos
 ```
 
 ## API
 
 ### Inputs
 
-- `github_token`: Required. GitHub API token to use for making API requests. This should be stored as a secret in the GitHub repository.
-- `automations`: Optional. You can include a comma-delimited list of specific automations you want to run if you don't want to use them all in a given workflow.
+-   `github_token`: Required. GitHub API token to use for making API requests. This should be stored as a secret in the GitHub repository.
+-   `automations`: Optional. You can include a comma-delimited list of specific automations you want to run if you don't want to use them all in a given workflow.
 
 ### Outputs
 
@@ -43,41 +44,41 @@ This will be expanded, but for reference:
 
 ### Developing
 
-- Clone the repo and then `npm install`.
+-   Clone the repo and then `npm install`.
 
 ### Builds and releases
 
-- All pushes to trunk will automatically build the `dist/index.js` file for the action (then commit and push to trunk). So no need to worry about builds.
-- For releases, make sure you update the examples in the `README.md` if releasing a major version, otherwise just create a release manually (in the future this may get automated for releases).
+-   All pushes to trunk will automatically build the `dist/index.js` file for the action (then commit and push to trunk). So no need to worry about builds.
+-   For releases, make sure you update the examples in the `README.md` if releasing a major version, otherwise just create a release manually (in the future this may get automated for releases).
 
 ### Adding a new automation.
 
 The design of this repository is setup so that automations can be their own discrete thing (eg. "todos") but still take advantage of various scaffolding and boilerplate when creating a new automation. The following is a rough list of steps to take to create and add a new automation:
 
-- Create a new directory in `lib/automations` that is the name of your automation.
-- Your `lib/automations` directory must at a minimum export the following from the `index.js` file in the directory:
+-   Create a new directory in `lib/automations` that is the name of your automation.
+-   Your `lib/automations` directory must at a minimum export the following from the `index.js` file in the directory:
 
 ```js
 module.exports = {
-  // the name of your automation
-  name: 'my-automation',
-  // what github action workflow events your automation reacts to.
-  events: [ 'pull_request' ],
-  // what github action workflow event actions your automation reacts to.
-  actions: [ 'opened' ],
-  // the runner for your automation.
-  runner
-}
+	// the name of your automation
+	name: 'my-automation',
+	// what github action workflow events your automation reacts to.
+	events: ['pull_request'],
+	// what github action workflow event actions your automation reacts to.
+	actions: ['opened'],
+	// the runner for your automation.
+	runner,
+};
 ```
-- As noted above, this export must include a `runner` for your automation. The runner is an async function that will receive two arguments: `context` (which is the GitHub action context value) and `octokit` (which is the GitHub api helper). See more about these two arguments [here](https://github.com/actions/toolkit/tree/trunk/packages/github) (they are essentially what gets exposed by the `@actions/github` package). You can use the [`todos` runner as an example](https://github.com/woocommerce/automations/blob/trunk/lib/automations/todos/runner.js).
-- Finally, in [`lib/automations.js`](https://github.com/woocommerce/automations/automations/blob/trunk/lib/automations.js), makes sure you import your automation configuration into this file and add it to the `moduleNames` array. So for example, if your automation was setup in `lib/automations/my-automation`, you would have something like this in the file after your changes:
 
-```js
+-   As noted above, this export must include a `runner` for your automation. The runner is an async function that will receive two arguments: `context` (which is the GitHub action context value) and `octokit` (which is the GitHub api helper). See more about these two arguments [here](https://github.com/actions/toolkit/tree/trunk/packages/github) (they are essentially what gets exposed by the `@actions/github` package). You can use the [`todos` runner as an example](https://github.com/woocommerce/automations/blob/trunk/lib/automations/todos/runner.js).
+-   Finally, in [`lib/automations.js`](https://github.com/woocommerce/automations/automations/blob/trunk/lib/automations.js), makes sure you import your automation configuration into this file and add it to the `moduleNames` array. So for example, if your automation was setup in `lib/automations/my-automation`, you would have something like this in the file after your changes:
 
-const todos = require( './automations/todos' );
-const myAutomation = require( './automations/my-automation' );
+```js
+const todos = require('./automations/todos');
+const myAutomation = require('./automations/my-automation');
 
-const moduleNames = [ todos, myAutomation ];
+const moduleNames = [todos, myAutomation];
 
 /**
  * @typedef {import('./typedefs').AutomationTask} AutomationTask
@@ -86,19 +87,18 @@ const moduleNames = [ todos, myAutomation ];
 /**
  * @type {AutomationTask[]}
  */
-const automations = moduleNames.map( ( module ) => module );
+const automations = moduleNames.map((module) => module);
 
 module.exports = automations;
 ```
 
-- make sure you list your automation name and a brief description of what it does in the **Available Automations** section of this readme file.
+-   make sure you list your automation name and a brief description of what it does in the **Available Automations** section of this readme file.
 
 That's it!
 
 Don't forget to add tests for your automation. There are various helpers available for mocking the `context` and `octokit` values (you can view the various todos automation tests for examples).
 
-
 ## Credits
 
-- Thanks to the work of the [Gutenberg team](https://github.com/wordpress/gutenberg) (particularly [@aduth](https://github.com/aduth)) in providing some inspiration for this approach to bundling various automations together.
-- The `todos` automation was inspired by this [todo probot app](https://github.com/JasonEtco/todo). Initial iterations of this action borrowed heavily from the ideas in this app.
+-   Thanks to the work of the [Gutenberg team](https://github.com/wordpress/gutenberg) (particularly [@aduth](https://github.com/aduth)) in providing some inspiration for this approach to bundling various automations together.
+-   The `todos` automation was inspired by this [todo probot app](https://github.com/JasonEtco/todo). Initial iterations of this action borrowed heavily from the ideas in this app.

README.md

@@ -8,4 +8,5 @@
 module.exports = [
 	require( './automations/todos' ),
 	require( './automations/release' ),
+	require( './automations/assign-milestone' ),
 ];

dist/index.js

@@ -0,0 +1,37 @@
+## Assign Milestone Automation
+
+When a pull request is approved and is not already assigned a milestone, this automation will assign the next milestone to it
+automatically.
+
+## Usage
+
+To implement this action, include it in your workflow configuration file:
+
+```yaml
+on:
+    pull_request:
+        types: [opened, synchronize, closed]
+    push:
+    issues:
+        types: [edited]
+jobs:
+    pull-request-automation:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: woocommerce/automations@v1
+              with:
+                  github_token: ${{ secrets.GITHUB_TOKEN }}
+                  # This can be a comma delimited list of automations to run, in this case we're just executing assign-milestone
+                  automations: assign-milestone
+```
+
+## API
+
+### Inputs
+
+-   `github_token`: Required. GitHub API token to use for making API requests. You can use the default `secrets.GITHUB_TOKEN` used by GitHub actions or store a different one in the secrets configuration of your GitHub repository.
+-   `automations`: Optional. You can include a comma-delimited list of specific automations you want to run if you don't want to use them all in a given workflow.
+
+### Outputs
+
+_None._

lib/automations.js

@@ -0,0 +1,8 @@
+const runner = require( './runner' );
+
+module.exports = {
+	name: 'assign-milestone',
+	events: [ 'pull_request_review' ],
+	actions: [ 'submitted', 'edited' ],
+	runner,
+};