Add support for GH Actions

Author: wooorm

index.js

@@ -17,8 +17,27 @@ function diff() {
 
   function transform(tree, file, next) {
     var base = file.dirname
-    var commitRange = process.env.TRAVIS_COMMIT_RANGE
-    var range = (commitRange || '').split(/\.{3}/)
+    var commitRange
+    var range
+
+    // Looks like Travis.
+    if (process.env.TRAVIS_COMMIT_RANGE) {
+      commitRange = process.env.TRAVIS_COMMIT_RANGE
+      range = commitRange.split(/\.{3}/)
+    }
+    // Looks like GH Actions.
+    else if (process.env.GITHUB_SHA) {
+      range =
+        // This is a PR: check the whole PR.
+        // Refs take the form `refs/heads/main`.
+        process.env.GITHUB_BASE_REF && process.env.GITHUB_HEAD_REF
+          ? [
+              process.env.GITHUB_BASE_REF.split('/').pop(),
+              process.env.GITHUB_HEAD_REF.split('/').pop()
+            ]
+          : [process.env.GITHUB_SHA + '^1', process.env.GITHUB_SHA]
+      commitRange = range.join('...')
+    }
 
     if (!base || !commitRange || range.length !== 2) {
       return next()

test/index.js

@@ -10,9 +10,22 @@ var processor = require('./processor')()
 
 var exec = promisify(cp.exec)
 
-test('diff()', function (t) {
-  var current = process.cwd()
-  var range = process.env.TRAVIS_COMMIT_RANGE
+var range = process.env.TRAVIS_COMMIT_RANGE
+var sha = process.env.GITHUB_SHA
+var base = process.env.GITHUB_BASE_REF
+var head = process.env.GITHUB_HEAD_REF
+
+// Remove potential variables that we’re testing on CIs.
+delete process.env.TRAVIS_COMMIT_RANGE
+delete process.env.GITHUB_SHA
+delete process.env.GITHUB_BASE_REF
+delete process.env.GITHUB_HEAD_REF
+
+var current = process.cwd()
+
+process.chdir(path.join(current, 'test'))
+
+test('diff() (travis)', function (t) {
   var stepOne = [
     'Lorem ipsum dolor sit amet.',
     '',
@@ -25,27 +38,11 @@ test('diff()', function (t) {
   var initial
   var final
 
-  delete process.env.TRAVIS_COMMIT_RANGE
-
   t.plan(7)
 
-  process.chdir(path.join(current, 'test'))
-
   exec('git init')
     // Set up.
-    .then(() => {
-      return exec('git config --global user.email').catch(oncatch)
-
-      function oncatch() {
-        return exec('git config --global user.email [email protected]').then(
-          onemail
-        )
-      }
-
-      function onemail() {
-        return exec('git config --global user.name Ex Ample')
-      }
-    })
+    .then(() => exec('git config --global user.email').catch(setEmailAndName))
     // Add initial file.
     .then(() =>
       processor.process(vfile({path: 'example.txt', contents: stepOne}))
@@ -64,16 +61,15 @@ test('diff()', function (t) {
     .then(() => exec('git rev-parse HEAD'))
     .then((result) => {
       initial = result.stdout.trim()
-      return vfile.write({path: 'example.txt', contents: stepTwo})
     })
-    // Changed files.
+    // Change files.
+    .then(() => vfile.write({path: 'example.txt', contents: stepTwo}))
     .then(() => exec('git add example.txt'))
     .then(() => exec('git commit -m two'))
     .then(() => exec('git rev-parse HEAD'))
     .then((result) => {
       final = result.stdout.trim()
       process.env.TRAVIS_COMMIT_RANGE = [initial, final].join('...')
-
       return processor.process(vfile({path: 'example.txt', contents: stepTwo}))
     })
     .then((file) => {
@@ -82,24 +78,22 @@ test('diff()', function (t) {
         ['example.txt:5:1-5:6: No lorem!'],
         'should show only messages for changed lines'
       )
-
-      return file
     })
     // Again!
-    .then(() => {
-      return processor.process(vfile({path: 'example.txt', contents: stepTwo}))
-    })
+    .then(() =>
+      processor.process(vfile({path: 'example.txt', contents: stepTwo}))
+    )
     .then((file) => {
       t.deepEqual(
         file.messages.map(String),
         ['example.txt:5:1-5:6: No lorem!'],
         'should not recheck (coverage for optimisations)'
       )
     })
-    // Unstages files.
-    .then(() => {
-      return processor.process(vfile({path: 'missing.txt', contents: other}))
-    })
+    // Unstaged files.
+    .then(() =>
+      processor.process(vfile({path: 'missing.txt', contents: other}))
+    )
     .then((file) => {
       t.deepEqual(file.messages.map(String), [], 'should ignore unstaged files')
     })
@@ -136,17 +130,111 @@ test('diff()', function (t) {
 
       return processor.process(vfile({path: 'new.txt', contents: other}))
     })
+    .then(
+      () => t.pass('should pass'),
+      (error) => t.ifErr(error, 'should not fail')
+    )
     // Restore
     .then(restore, restore)
+
+  function restore() {
+    delete process.env.TRAVIS_COMMIT_RANGE
+    return rimraf('.git')
+      .then(() => rimraf('new.txt'))
+      .then(() => rimraf('example.txt'))
+  }
+})
+
+test('diff() (GitHub Actions)', function (t) {
+  var stepOne = [
+    'Lorem ipsum dolor sit amet.',
+    '',
+    'Lorem ipsum. Dolor sit amet.',
+    ''
+  ].join('\n')
+  var stepTwo = stepOne + '\nLorem ipsum.\n'
+  var stepThree = 'Lorem.\n\n' + stepOne + '\nAlpha bravo.\n'
+  var stepFour = stepThree + '\nIpsum lorem.\n'
+  var main
+
+  t.plan(3)
+
+  exec('git init')
+    // Set up.
+    .then(() => exec('git config --global user.email').catch(setEmailAndName))
+    // Add initial file.
+    .then(() => vfile.write({path: 'example.txt', contents: stepOne}))
+    .then(() => exec('git add example.txt'))
+    .then(() => exec('git commit -m one'))
+    // Change file.
+    .then(() => vfile.write({path: 'example.txt', contents: stepTwo}))
+    .then(() => exec('git add example.txt'))
+    .then(() => exec('git commit -m two'))
+    .then(() => exec('git rev-parse HEAD'))
+    .then((result) => {
+      process.env.GITHUB_SHA = result.stdout.trim()
+      return processor.process(vfile({path: 'example.txt', contents: stepTwo}))
+    })
+    .then((file) => {
+      t.deepEqual(
+        file.messages.map(String),
+        ['example.txt:5:1-5:6: No lorem!'],
+        'should show only messages for this commit'
+      )
+    })
+    // A PR.
+    .then(() => exec('git branch --show-current'))
+    .then((result) => {
+      main = result.stdout.trim()
+      exec('git checkout -b other-branch')
+    })
+    // Change file.
+    .then(() => vfile.write({path: 'example.txt', contents: stepThree}))
+    .then(() => exec('git add example.txt'))
+    .then(() => exec('git commit -m three'))
+    .then(() => vfile.write({path: 'example.txt', contents: stepFour}))
+    .then(() => exec('git add example.txt'))
+    .then(() => exec('git commit -m four'))
+    .then(() => exec('git rev-parse HEAD'))
+    .then((result) => {
+      process.env.GITHUB_SHA = result.stdout.trim()
+      process.env.GITHUB_BASE_REF = 'refs/heads/' + main
+      process.env.GITHUB_HEAD_REF = 'refs/heads/other-branch'
+      return processor.process(vfile({path: 'example.txt', contents: stepFour}))
+    })
+    .then((file) => {
+      t.deepEqual(
+        file.messages.map(String),
+        ['example.txt:1:1-1:6: No lorem!', 'example.txt:9:7-9:12: No lorem!'],
+        'should deal with PRs'
+      )
+    })
+    // Restore
     .then(
       () => t.pass('should pass'),
       (error) => t.ifErr(error, 'should not fail')
     )
+    .then(restore, restore)
 
   function restore() {
-    process.env.TRAVIS_COMMIT_RANGE = range
     return rimraf('.git')
       .then(() => rimraf('new.txt'))
       .then(() => rimraf('example.txt'))
   }
 })
+
+process.on('exit', function () {
+  process.env.TRAVIS_COMMIT_RANGE = range
+  process.env.GITHUB_SHA = sha
+  process.env.GITHUB_BASE_REF = base
+  process.env.GITHUB_HEAD_REF = head
+  process.chdir(path.join(current))
+})
+
+function setEmailAndName() {
+  return exec('git config --global user.email [email protected]').then(setEmail)
+}
+
+function setEmail() {
+  return exec('git config --global user.name Ex Ample')
+}