initial commit

Author: gautamkrishnar

.editorconfig

@@ -0,0 +1,18 @@
+# http://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+max_line_length = 120
+trim_trailing_whitespace = true
+
+[*.md]
+max_line_length = 0
+trim_trailing_whitespace = false
+
+[COMMIT_EDITMSG]
+max_line_length = 0

.gitignore

@@ -0,0 +1,115 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+*.lcov
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# Snowpack dependency directory (https://snowpack.dev/)
+web_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+.env.test
+
+# parcel-bundler cache (https://parceljs.org/)
+.cache
+.parcel-cache
+
+# Next.js build output
+.next
+out
+
+# Nuxt.js build / generate output
+.nuxt
+
+# Gatsby files
+.cache/
+# Comment in the public line in if your project uses Gatsby and not Next.js
+# https://nextjs.org/blog/next-9-1#public-directory-support
+# public
+
+# vuepress build output
+.vuepress/dist
+
+# Serverless directories
+.serverless/
+
+# FuseBox cache
+.fusebox/
+
+# DynamoDB Local files
+.dynamodb/
+
+# TernJS port file
+.tern-port
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v2
+.yarn/cache
+.yarn/unplugged
+.yarn/build-state.yml
+.yarn/install-state.gz
+.pnp.*

.jshintrc

@@ -0,0 +1,16 @@
+{
+  "node": true,
+  "esversion": 9,
+  "camelcase": true,
+  "curly": true,
+  "eqeqeq": true,
+  "evil": true,
+  "freeze": true,
+  "indent": 2,
+  "newcap": true,
+  "quotmark": "single",
+  "maxlen": 120,
+  "eqnull": true,
+  "funcscope": true,
+  "globals": {}
+}

.npmrc

@@ -0,0 +1 @@
+scripts-prepend-node-path=true

README.md

@@ -1,2 +1,10 @@
-# keepalive-workflow
-GitHub action to prevent GitHub from suspending your cronjob based trigger due to repository inactivity 
+# Keepalive Workflow
+GitHub action to prevent GitHub from suspending your cronjob based triggers due to repository inactivity
+
+### Why ?
+GitHub will suspend the scheduled trigger for GitHub action workflows if there is no commit in the repository for the past 60 days. The cron based triggers won't run unless a new commit is made.
+![preview](https://user-images.githubusercontent.com/8397274/105174930-4303e100-5b49-11eb-90ed-95a55697582f.png)
+
+### What ?
+This workflow will automatically create a dummy commit in your repo if the last commit in your repo is 50 days (default) ago.
+This will keep the cronjob trigger active, so that it will run indefinitely without getting suspended by GitHub for inactivity.

action.yml

@@ -0,0 +1,32 @@
+name: 'Keepalive Workflow'
+author: 'Gautam Krishna R'
+description: 'GitHub action to prevent GitHub from suspending your cronjob based triggers due to repository inactivity'
+
+inputs:
+  gh_token:
+    description: 'GitHub access token with Repo scope'
+    required: false
+    default: ${{ github.token }}
+  commit_message:
+    description: "Commit message used while committing to the repo"
+    default: "Automated commit by Keepalive Workflow to keep the repository active"
+    required: false
+  committer_username:
+    description: "Username used while committing to the repo"
+    default: "keepalive-workflow-bot"
+    required: false
+  committer_email:
+    description: "Email id used while committing to the repo"
+    default: "[email protected]"
+    required: false
+  time_elapsed:
+    description: "Time elapsed from the last commit to trigger a new automated commit (in days)"
+    default: "50"
+    required: false
+
+runs:
+  using: node12
+  main: dist/index.js
+branding:
+  icon: 'truck'
+  color: 'blue'

dist/index.js

@@ -0,0 +1,67 @@
+const core = require('@actions/core');
+const {execute} = require('util');
+
+/**
+ * Keep Alive Workflow
+ * @type {Promise<string>}
+ */
+const KeepAliveWorkflow = new Promise(async (resolve, reject) => {
+  try {
+    // Getting config
+    const githubToken = core.getInput('gh_token');
+    const committerUsername = core.getInput('committer_username');
+    const committerEmail = core.getInput('committer_email');
+    const commitMessage = core.getInput('commit_message');
+    const timeElapsed = parseInt(core.getInput('time_elapsed'));
+
+    // Calculating the last commit date
+    const {outputData} = await execute('git', ['--no-pager', 'log', '-1', '--format=%ct'],
+      {encoding: 'utf8', stdio: ['pipe', 'pipe', 'pipe']});
+
+    const commitDate = new Date(parseInt(outputData, 10) * 1000);
+    const diffInDays = Math.round((new Date() - commitDate) / (1000 * 60 * 60 * 24));
+
+    if (diffInDays > timeElapsed) {
+      // Do dummy commit if elapsed time is greater than 50 (default) days
+      core.info('Doing dummy commit to keep repository active');
+      await execute('git', [
+        'config',
+        '--global',
+        'user.email',
+        committerEmail,
+      ]);
+      await execute('git', [
+        'remote',
+        'set-url',
+        'origin',
+        `https://${githubToken}@github.com/${process.env.GITHUB_REPOSITORY}.git`
+      ]);
+      await execute('git', [
+        'config',
+        '--global',
+        'user.name',
+        committerUsername
+      ]);
+      await execute('git', [
+        'commit',
+        '--allow-empty',
+        '-m',
+        `"${commitMessage}"`]);
+      resolve('Dummy commit created...');
+    } else {
+      resolve('Nothing to do');
+    }
+  } catch (e) {
+    reject(e.toString());
+  }
+});
+
+KeepAliveWorkflow
+  .then((message) => {
+    core.info(message);
+    process.exit(1);
+  })
+  .catch((error) => {
+    core.error(error);
+    process.exit(1);
+  });

index.js

@@ -0,0 +1,36 @@
+{
+  "name": "keepalive-workflow",
+  "version": "1.0.0",
+  "description": "GitHub action to prevent GitHub from suspending your cronjob based trigger due to repository inactivity",
+  "main": "index.js",
+  "scripts": {
+    "build": "parcel build  --no-source-maps --target=node --bundle-node-modules index.js",
+    "lint": "jshint --exclude='node_modules/' *.js"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/gautamkrishnar/keepalive-workflow.git"
+  },
+  "keywords": [
+    "github",
+    "workflow",
+    "keepalive",
+    "action"
+  ],
+  "author": "Gautam krishna R <[email protected]> (https://www.github.com/gautamkrishnar)",
+  "license": "GPL-3.0",
+  "bugs": {
+    "url": "https://github.com/gautamkrishnar/keepalive-workflow/issues"
+  },
+  "homepage": "https://github.com/gautamkrishnar/keepalive-workflow#readme",
+  "dependencies": {
+    "@actions/core": "^1.5.0",
+    "process": "latest"
+  },
+  "devDependencies": {
+    "jshint": "^2.12.0",
+    "mocha": "^8.1.3",
+    "parcel-bundler": "^1.12.4",
+    "start-server-and-test": "^1.11.3"
+  }
+}

package.json

@@ -0,0 +1,37 @@
+const {spawn} = require('child_process');
+
+/**
+ * Executes a command and returns its result as promise
+ * @param cmd {string} command to execute
+ * @param args {array} command line args
+ * @param options {Object} extra options
+ * @return {Promise<Object>}
+ */
+const execute = (cmd, args = [], options = {}) => new Promise((resolve, reject) => {
+  let outputData = '';
+  const optionsToCLI = {
+    ...options
+  };
+  if (!optionsToCLI.stdio) {
+    Object.assign(optionsToCLI, {stdio: ['inherit', 'inherit', 'inherit']});
+  }
+  const app = spawn(cmd, args, optionsToCLI);
+  if (app.stdout) {
+    // Only needed for pipes
+    app.stdout.on('data', function (data) {
+      outputData += data.toString();
+    });
+  }
+
+  app.on('close', (code) => {
+    if (code !== 0) {
+      return reject({code, outputData});
+    }
+    return resolve({code, outputData});
+  });
+  app.on('error', () => reject({code: 1, outputData}));
+});
+
+module.exports = {
+  execute
+};