cleanup, add readme

Author: jonabc

.github/workflows/mirror.yml

@@ -1,7 +1,7 @@
 name: "mirror repo projects"
 on: # run this on a cron schedule
   schedule:
-    - cron: '*/3 * * * *'
+    - cron: '*/5 * * * *'
   push:
 
 jobs:

README.md

@@ -2,100 +2,60 @@
   <a href="https://github.com/actions/typescript-action/actions"><img alt="typescript-action status" src="https://github.com/actions/typescript-action/workflows/build-test/badge.svg"></a>
 </p>
 
-# Create a JavaScript Action using TypeScript
+# GitHub Projects Column Mirror
 
-Use this template to bootstrap the creation of a JavaScript action.:rocket:
+This is a GitHub Action to mirror columns in hierarchically modeled GitHub Projects.
 
-This template includes compilication support, tests, a validation workflow, publishing, and versioning guidance.  
+As an example, let's assume a scenario where there are issues used to document both epic and feature level scopes of work, where features belong to epics.
 
-If you are new, there's also a simpler introduction.  See the [Hello World JavaScript Action](https://github.com/actions/hello-world-javascript-action)
+In this scenario, we have two project boards to individually track and give visibility into epics and features individually.  Each project board has the following columns:
+- backlog
+- active
+- done
 
-## Create an action from this template
+If individual teams, or individual roles within a team, are only looking at the feature board then it can be hard to tell what epics are actively being worked on.
 
-Click the `Use this Template` and provide the new repo details for your action
+This action makes this scenario easier by actively mirroring columns across project boards.  We can create an `active epics` column on the feature board that will automatically stay up to date with the `active` column on the epics project board.
 
-## Code in Master
+## Usage
 
-Install the dependencies  
-```bash
-$ npm install
-```
+The action is intended to be run on a cron schedule, see [mirror.yml](./.github/workflows/mirror.yml) for an example.  The linked action workflow also uses the `push` event trigger for testing purposes only, and is not generally recommended for use.
 
-Build the typescript and package it for distribution
-```bash
-$ npm run build && npm run pack
 ```
-
-Run the tests :heavy_check_mark:  
-```bash
-$ npm test
-
- PASS  ./index.test.js
-  ✓ throws invalid number (3ms)
-  ✓ wait 500 ms (504ms)
-  ✓ test runs (95ms)
-
-...
+on:
+  schedule:
+    cron:
+      # cron actions will not run more frequently than once every 5 minutes
+      - '*/5 * * * *'
+jobs:
+  mirror_column:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: jonabc/linked-project-columns@<version>
+      with:
+        source_column_id: <column node id>
+        target_column_id: <column node id>
+        github_token: ${{ secrets.MIRROR_SECRET_PAT }}
 ```
 
-## Change action.yml
-
-The action.yml contains defines the inputs and output for your action.
-
-Update the action.yml with your name, description, inputs and outputs for your action.
-
-See the [documentation](https://help.github.com/en/articles/metadata-syntax-for-github-actions)
+### Added notice card
 
-## Change the Code
+The action will add a notice to the top of the target project column, identifying the source project column and notifying users that the column is automatically managed.
 
-Most toolkit and CI/CD operations involve async operations so the action is run in an async function.
+### Required permissions
 
-```javascript
-import * as core from '@actions/core';
-...
+The `${{ secrets.GITHUB_TOKEN }}` token can be used only when all project columns being accessed live in the target repository.  For organization or user owned projects, a personal access token will need to be used that has the following permissions at a minimum:
+1. `write:org` to update organization projects
+2. `repo` to access information in private repositories
+3. `user` to access information in user repositories (if needed)
 
-async function run() {
-  try { 
-      ...
-  } 
-  catch (error) {
-    core.setFailed(error.message);
-  }
-}
 
-run()
-```
-
-See the [toolkit documentation](https://github.com/actions/toolkit/blob/master/README.md#packages) for the various packages.
 
-## Publish to a distribution branch
 
-Actions are run from GitHub repos so we will checkin the packed dist folder. 
-
-Then run [ncc](https://github.com/zeit/ncc) and push the results:
-```bash
-$ npm run pack
-$ git add dist
-$ git commit -a -m "prod dependencies"
-$ git push origin releases/v1
-```
 
-Your action is now published! :rocket: 
 
-See the [versioning documentation](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md)
 
-## Validate
-
-You can now validate the action by referencing `./` in a workflow in your repo (see [test.yml](.github/workflows/test.yml)])
-
-```yaml
-uses: ./
-with:
-  milliseconds: 1000
-```
 
-See the [actions tab](https://github.com/actions/javascript-action/actions) for runs of this action! :rocket:
 
-## Usage:
 
-After testing you can [create a v1 tag](https://github.com/actions/toolkit/blob/master/docs/action-versioning.md) to reference the stable and latest V1 action

src/main.ts

@@ -50,7 +50,6 @@ async function ensureCard(
 
   if (!targetCard) {
     // add!
-    core.info(`Creating card in ${targetColumn.name}`)
     const cardData: any = {}
     if (card.content) {
       cardData.contentId = card.content.id
@@ -71,12 +70,10 @@ async function ensureCard(
     targetCard = response['addProjectCard'].cardEdge.node
     targetColumn.cards.nodes.unshift(targetCard)
     targetCardIndex = 0
-    core.info(`created card: ${targetCard.id}`)
   }
 
   if (targetCardIndex !== index) {
     // move!
-    core.info(`moving card: ${targetCard.id}`)
     const moveData = {
       cardId: targetCard.id,
       columnId: targetColumn.id,
@@ -92,8 +89,6 @@ async function ensureCard(
       targetColumn.cards.nodes.splice(targetCardIndex, 1)[0]
     )
     targetCardIndex = index
-
-    core.info(`moved card: ${targetCard.id} after ${moveData.afterCardId}`)
   }
 
   return targetCard

tsconfig.json

@@ -5,7 +5,7 @@
     "outDir": "./lib",                        /* Redirect output structure to the directory. */
     "rootDir": "./src",                       /* Specify the root directory of input files. Use to control the output directory structure with --outDir. */
     "strict": true,                           /* Enable all strict type-checking options. */
-    "noImplicitAny": true,                    /* Raise error on expressions and declarations with an implied 'any' type. */
+    "noImplicitAny": false,                    /* Raise error on expressions and declarations with an implied 'any' type. */
     "esModuleInterop": true,                  /* Enables emit interoperability between CommonJS and ES Modules via creation of namespace objects for all imports. Implies 'allowSyntheticDefaultImports'. */
     "lib": ["es2020.string"]
   },