Add GitHub Action support (OctoLinker#699)

Reconix · Nov 10, 2019 · b196ff8 · b196ff8
1 parent b46de9c
commit b196ff8
Show file tree

Hide file tree

Showing 8 changed files with 82 additions and 0 deletions.
diff --git a/e2e/fixtures/.github/workflows/ci.yml b/e2e/fixtures/.github/workflows/ci.yml
@@ -0,0 +1,13 @@
+name: "Test"
+on: ['push']
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+    # @OctoLinkerResolve(https://github.com/actions/checkout)
+    - uses: actions/checkout@v1
+    # @OctoLinkerResolve(https://github.com/actions/setup-node)
+    - uses: actions/setup-node
+    # @OctoLinkerResolve(https://github.com/actions/upload-artifact)
+    - uses: actions/upload-artifact@master
diff --git a/packages/core/load-plugins.js b/packages/core/load-plugins.js
@@ -25,3 +25,4 @@ export { default as Rust } from '@octolinker/plugin-rust';
 export { default as Sass } from '@octolinker/plugin-sass';
 export { default as TypeScript } from '@octolinker/plugin-typescript';
 export { default as Vim } from '@octolinker/plugin-vim';
+export { default as GitHubActions } from '@octolinker/plugin-github-actions';
diff --git a/packages/core/package.json b/packages/core/package.json
@@ -20,6 +20,7 @@
     "@octolinker/plugin-dot-net": "1.0.0",
     "@octolinker/plugin-dot-net-core": "1.0.0",
     "@octolinker/plugin-gemfile-manifest": "1.0.0",
+    "@octolinker/plugin-github-actions": "1.0.0",
     "@octolinker/plugin-go": "1.0.0",
     "@octolinker/plugin-haskell": "1.0.0",
     "@octolinker/plugin-homebrew-manifest": "1.0.0",

diff --git a/packages/helper-grammar-regex-collection/index.js b/packages/helper-grammar-regex-collection/index.js
@@ -166,6 +166,10 @@ export const NET_PACKAGE = regex`
   .*/>
 `;
 
+export const GITHUB_ACTIONS = regex`
+  uses:\s(?<$1>[^@\s]+)
+`;
+
 export const JAVA_IMPORT = regex`
   ${diffSigns}
   import

diff --git a/packages/helper-grammar-regex-collection/test.js b/packages/helper-grammar-regex-collection/test.js
@@ -464,6 +464,14 @@ const fixtures = {
       '< DotNetCliToolReference  Include="Microsoft.DotNet.Xdt.Tools" Version="2.0.0" />',
     ],
   },
+  GITHUB_ACTIONS: {
+    valid: [
+      ['uses: foo/bar', ['foo/bar']],
+      ['uses: foo/bar@v1', ['foo/bar']],
+      ['uses: foo/bar@master', ['foo/bar']],
+    ],
+    invalid: [],
+  },
 };
 
 function fixturesIterator(fixturesList, next) {

diff --git a/packages/plugin-github-actions/__tests__/index.js b/packages/plugin-github-actions/__tests__/index.js
@@ -0,0 +1,20 @@
+import assert from 'assert';
+import GiHubActions from '../index';
+
+describe('GiHubActions', () => {
+  const target = 'foo/bar';
+
+  it('resolves link when file is within .github/workflows', () => {
+    assert.deepEqual(
+      GiHubActions.resolve('/octo/cat/.github/workflows/dog.yml', [target]),
+      '{BASE_URL}/foo/bar',
+    );
+  });
+
+  it('does not resolves link when file is not within .github/workflows', () => {
+    assert.deepEqual(
+      GiHubActions.resolve('/octo/cat/.github/dog.yml', [target]),
+      '',
+    );
+  });
+});
diff --git a/packages/plugin-github-actions/index.js b/packages/plugin-github-actions/index.js
@@ -0,0 +1,24 @@
+import { GITHUB_ACTIONS } from '@octolinker/helper-grammar-regex-collection';
+
+export default {
+  name: 'GitHubActions',
+
+  resolve(path, [target]) {
+    if (!path.includes('.github/workflows')) {
+      return '';
+    }
+
+    return `{BASE_URL}/${target}`;
+  },
+
+  getPattern() {
+    return {
+      pathRegexes: [/\.ya?ml$/],
+      githubClasses: [],
+    };
+  },
+
+  getLinkRegexes() {
+    return GITHUB_ACTIONS;
+  },
+};
diff --git a/packages/plugin-github-actions/package.json b/packages/plugin-github-actions/package.json
@@ -0,0 +1,11 @@
+{
+  "name": "@octolinker/plugin-github-actions",
+  "version": "1.0.0",
+  "description": "",
+  "repository": "https://github.com/octolinker/octolinker/tree/master/packages/plugin-github-actions",
+  "license": "MIT",
+  "main": "./index.js",
+  "dependencies": {
+    "@octolinker/helper-grammar-regex-collection": "1.0.0"
+  }
+}