feat: initial commit with github action to update notion tasks

Author: techpool

Diff for: .editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true

Diff for: .eslintrc.js

@@ -0,0 +1,77 @@
+module.exports = {
+  env: {
+    browser: true,
+    commonjs: true,
+    es2021: true,
+  },
+  extends: 'eslint:recommended',
+  parserOptions: {
+    ecmaVersion: 13,
+  },
+  globals: {
+    process: 'readonly',
+  },
+  rules: {
+    'no-extend-native': [ 'error', { exceptions: [ 'Array' ] } ],
+    'no-global-assign': [ 'error', { exceptions: [ 'self' ] } ],
+    'generator-star-spacing': 'off',
+    // eslint-disable-next-line no-undef
+    'no-debugger': process.env.NODE_ENV === 'production' ? 'error' : 'off',
+    'no-trailing-spaces': [ 'error', { skipBlankLines: true } ],
+    'array-bracket-spacing': [ 'error', 'always' ],
+    'arrow-body-style': [ 'warn', 'as-needed' ],
+    'standard/no-callback-literal': 0,
+    'comma-dangle': [
+      'warn',
+      {
+        arrays: 'always-multiline',
+        objects: 'always-multiline',
+        imports: 'never',
+        exports: 'never',
+        functions: 'ignore',
+      },
+    ],
+    'curly': [ 'warn', 'multi-line' ],
+    'eol-last': [ 'error', 'always' ],
+    'indent': [ 'error', 2, { SwitchCase: 1, VariableDeclarator: 1 } ],
+    'max-len': [
+      'warn',
+      {
+        code: 140,
+        ignoreComments: true,
+        ignoreTrailingComments: true,
+        ignoreStrings: true,
+        ignorePattern: '.+=".+"',
+      },
+    ],
+    'no-multiple-empty-lines': [ 'error', { max: 1, maxEOF: 1 } ],
+    'no-prototype-builtins': 0,
+    'object-curly-spacing': [ 'error', 'always' ],
+    'object-property-newline': [ 'error', { allowAllPropertiesOnSameLine: true } ],
+    'padded-blocks': 'off',
+    'prefer-const': [ 'error', { destructuring : 'all' } ],
+    'prefer-template': 'error',
+    'quote-props': [ 'error', 'consistent-as-needed' ],
+    'quotes': [
+      'error',
+      'single',
+      {
+        avoidEscape: true,
+        // TODO: Remove this rule and autofix,
+        // as we don't need useless template literals
+        allowTemplateLiterals: true,
+      },
+    ],
+    'semi': [ 'error', 'never', { beforeStatementContinuationChars: 'never' } ],
+    'space-before-function-paren': [ 'warn', 'always' ],
+    'spaced-comment': [
+      'error',
+      'always',
+      {
+        block: {
+          markers: [ '!' ],
+        },
+      },
+    ],
+  },
+}

Diff for: .github/workflows/eslint.yml

@@ -0,0 +1,54 @@
+# This is a basic workflow to help you get started with Actions
+name: Lint
+
+# Controls when the action will run. Triggers the workflow on push or pull request
+# events but on dev and staging branches
+on:
+  pull_request:
+    branches:
+      - main
+      - 'feature/**'
+      - 'features/**'
+  push:
+    branches:
+      - main
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+  prepare:
+    name: Prepare & Cleanup Previous Runs
+    if: always()
+    runs-on: ubuntu-latest
+    outputs:
+      commit_message: ${{ steps.get_message.outputs.commit_message }}
+
+    steps:
+    - uses: actions/checkout@v1
+    - uses: rokroskar/workflow-run-cleanup-action@v0.2.2
+      env:
+        GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
+    - id: get_message
+      name: Set Commit Message
+      run: echo ::set-output name=commit_message::$(git log --format=%B -n 1 ${{ github.event.after }})
+    - name: Show Commit Message
+      run: echo "${{ steps.get_message.outputs.commit_message }}"
+
+  lint-and-units:
+    name: ESLint
+    needs: prepare
+    timeout-minutes: 45
+    if: (github.event.pull_request.draft == false) && !startsWith(github.head_ref, 'tech') && !startsWith(github.head_ref, 'doc') && !contains(needs.prepare.outputs.commit_message, '[skip ci]')
+    # The type of runner that the job will run on
+    runs-on: ubuntu-18.04
+    steps:
+    - name: Show Commit Message
+      run: echo "${{ needs.prepare.outputs.commit_message }}"
+    # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+    - uses: actions/checkout@v2
+    - name: Use Node.js
+      uses: actions/setup-node@v1
+      with:
+        node-version: '16.x'
+    - name: Run ESLint
+      if: always()
+      run: npm run lint

Diff for: package-lock.json

@@ -0,0 +1,62 @@
+{
+  "name": "notion-scripts",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "lint": "npx eslint --ext .js ."
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/coursedog/notion-scripts.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/coursedog/notion-scripts/issues"
+  },
+  "homepage": "https://github.com/coursedog/notion-scripts#readme",
+  "dependencies": {
+    "@actions/core": "^1.6.0",
+    "@actions/github": "^5.0.0",
+    "@notionhq/client": "^0.4.9"
+  },
+  "devDependencies": {
+    "eslint": "^8.3.0",
+    "husky": "^7.0.4",
+    "lint-staged": "^12.1.2"
+  },
+  "husky": {
+    "hooks": {
+      "pre-commit": "lint-staged"
+    }
+  },
+  "lint-staged": {
+    "src/**/*.{js,vue}": [
+      "eslint --fix",
+      "git add"
+    ],
+    "server/**/*.js": [
+      "eslint --fix",
+      "git add"
+    ],
+    "shared/**/*.js": [
+      "eslint --fix",
+      "git add"
+    ],
+    "scripts/**/*.js": [
+      "eslint --fix",
+      "git add"
+    ],
+    "packages/**/*.ts": [
+      "eslint --fix",
+      "git add"
+    ],
+    "tests/e2e/specs/**/*.js": [
+      "eslint --fix",
+      "git add"
+    ]
+  }
+}

Diff for: package.json

@@ -0,0 +1,14 @@
+name: 'Update Notion Task Status'
+description: 'Github Action to Update Notion Task when a PR has been merged to a particular stage'
+inputs:
+  NOTION_API_KEY:  # id of input
+    description: 'API Key to get access to the notion board'
+    required: true
+    default: ''
+  NOTION_DATABASE_TOKEN:  # id of input
+    description: 'Token to identify the task board in which the change is going to happen'
+    required: true
+    default: ''
+runs:
+  using: 'node16'
+  main: 'index.js'

Diff for: update_notion/action.yml

@@ -0,0 +1,93 @@
+const core = require('@actions/core')
+const { Octokit } = require('@octokit/rest')
+
+const Notion = require('./../utils/notion')
+
+try {
+  const {
+    GITHUB_REF,
+  } = process.env
+
+  if (GITHUB_REF === 'refs/heads/master') {
+    _updateNotionStatuses('master')
+  } else if (GITHUB_REF === 'refs/heads/staging') {
+    _updateNotionStatuses('staging')
+  } else if (GITHUB_REF === 'refs/heads/dev') {
+    _updateNotionStatuses('dev')
+  }
+} catch (error) {
+  core.setFailed(error.message)
+}
+
+/**
+ * Function to update the status of the tasks based on
+ * the recent commit is getting merged to which branch
+ *
+ * @param {'dev' | 'staging' | 'master' } branch Name of the branch to which the commit is getting merged to
+ */
+async function _updateNotionStatuses (branch) {
+
+  const {
+    GITHUB_REPOSITORY,
+    GITHUB_TOKEN,
+    GITHUB_OWNER,
+  } = process.env
+
+  const octokit = new Octokit({
+    auth: GITHUB_TOKEN,
+  })
+
+  const NOTION_DATABASE_TOKEN = core.getInput('NOTION_DATABASE_TOKEN')
+  const NOTION_API_KEY = core.getInput('NOTION_API_KEY')
+
+  const notionUtil = new Notion({
+    apiKey: NOTION_API_KEY,
+    databaseToken: NOTION_DATABASE_TOKEN,
+  })
+
+  const repositoryName = GITHUB_REPOSITORY.split('/').pop()
+  
+  // Get most recent commit to branch
+  const { data } = await octokit.rest.repos.getCommit({
+    owner: GITHUB_OWNER,
+    repo: GITHUB_REPOSITORY,
+    ref: branch,
+    perPage: 1,
+    page: 1,
+  })
+
+  const {
+    commit: {
+      message: commitMessage,
+    },
+  } = data
+
+  switch (branch) {
+    case 'master':
+      if (commitMessage.includes('from coursedog/staging')) {
+        // Update all tasks that are in Completed Staging to Completed Prod
+        notionUtil.updateByStatus('Completed (Staging)', 'Completed (Production)')
+      }
+      break
+    case 'staging':
+      if (commitMessage.includes('from coursedog/dev')) {
+        // Update all tasks that are in Completed Dev to Completed Staging
+        notionUtil.updateByStatus('Completed (Dev)', 'Completed (Staging)')
+      } else if (commitMessage.match(/#+[0-9]/)) {
+        // direct from open PR to staging
+        const prNumber = commitMessage.split('#')[1].replace(/\D/g, '')
+        notionUtil.updateByPR(`${repositoryName}/pull/${prNumber}`, 'Completed (Staging)')
+      }
+      break
+    case 'dev':
+      if (commitMessage.match(/#+[0-9]/)) {
+        // direct from open PR to dev
+        const prNumber = commitMessage.split('#')[1].replace(/\D/g, '')
+        notionUtil.updateByPR(`${repositoryName}/pull/${prNumber}`, 'Completed (Dev)')
+      }
+      break
+  
+    default:
+      break
+  }
+}

Diff for: update_notion/index.js

@@ -0,0 +1,121 @@
+const { Client }= require('@notionhq/client')
+
+class Notion {
+  constructor ({ apiKey, databaseToken }) {
+    // Retrieving all the input parameters relevant to notion
+    this.notionDatabaseToken = databaseToken
+      
+    // Initializing the notion client
+    this.client = new Client({ auth: apiKey })
+    this.labels = {
+      GITHUB_PR: 'GitHub PR',
+      STATUS: 'Status',
+      DATE_COMPLETED: 'Date Completed',
+    }
+  }
+
+  /**
+   * Function to update the status of a particular task from one to the other one
+   *
+   * @param {String} originalStatus Status from which the task is to be moved
+   * @param {String} newStatus Status to which the status is to be moved
+   */
+  async updateByStatus (originalStatus, newStatus) {
+    console.log('Updating all Notion tasks from', originalStatus, 'to', newStatus)
+    const databaseId = this.notionDatabaseToken
+    const {
+      GITHUB_REPOSITORY,
+    } = process.env
+    const repositoryName = GITHUB_REPOSITORY.split('/').pop()
+
+    const listOfTasks = await this.client.databases.query({
+      database_id: databaseId,
+      filter: {
+        and: [
+          {
+            property: this.labels.STATUS,
+            select: {
+              equals: originalStatus,
+            },
+          },
+          {
+            property: this.labels.GITHUB_PR,
+            text: {
+              contains: repositoryName,
+            },
+          },
+        ],
+      },
+    })
+    for (let i = 0; i < listOfTasks.results.length; i++) {
+      const updatedTasks = await this.client.pages.update({
+        page_id: listOfTasks.results[i].id,
+        properties: {
+          Status: {
+            select: {
+              name: newStatus,
+            },
+          },
+        },
+      })
+      console.log('Updated', updatedTasks)
+    }
+  }
+
+  /**
+   * Function to promote the task by the Github PR field
+   *
+   * @param {String} pr PR URL for which the status is to be updated
+   * @param {String} newStatus New status to which the task is to be promoted
+   */
+  async updateByPR (pr, newStatus) {
+    console.log('Updating one Notion task with PR', pr, 'to', newStatus)
+    const databaseId = this.notionDatabaseToken
+    const listOfTasks = await this.client.databases.query({
+      database_id: databaseId,
+      filter: {
+        and: [
+          {
+            property: this.labels.GITHUB_PR,
+            text: {
+              ends_with: pr,
+            },
+          },
+          {
+            property: this.labels.STATUS,
+            select: {
+              does_not_equal: 'Completed (old)',
+            },
+          },
+          {
+            property: this.labels.STATUS,
+            select: {
+              does_not_equal: 'Completed (Production)',
+            },
+          },
+        ],
+      },
+    })
+    for (let i = 0; i < listOfTasks.results.length; i++) {
+      const updatedTasks = await this.client.pages.update({
+        page_id: listOfTasks.results[i].id,
+        properties: {
+          [this.labels.STATUS]: {
+            select: {
+              name: newStatus,
+            },
+          },
+          [this.labels.DATE_COMPLETED]: {
+            date: {
+              start: new Date().toISOString(),
+            },
+          },
+        },
+      })
+      console.log('Updated', updatedTasks)
+    }
+  }
+  
+}
+
+module.exports = Notion