initial commit

Author: cmpxchg16

.github/workflows/main.yml

@@ -0,0 +1,42 @@
+name: CI
+
+# Controls when the workflow will run 
+on: [push, workflow_dispatch]
+
+env:
+  SPECTRAL_DSN: ${{ secrets.SPECTRAL_DSN }}
+
+jobs:
+  ubuntu:
+    name: Spectral ubuntu
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Spectral
+        uses: ./
+        with:
+          spectral-dsn: ${{ secrets.SPECTRAL_DSN }}
+      - name: Spectral Scan
+        run: spectral scan
+  macOS:
+    name: Spectral macOS
+    runs-on: macos-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Spectral
+        uses: ./
+        with:
+          spectral-dsn: ${{ secrets.SPECTRAL_DSN }}
+      - name: Spectral Scan
+        run: spectral scan
+  windows:
+    name: Spectral windows
+    runs-on: windows-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Install Spectral
+        uses: ./
+        with:
+          spectral-dsn: ${{ secrets.SPECTRAL_DSN }}
+      - name: Spectral Scan
+        run: spectral.exe scan

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2021 SpectralOps
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

README.md

@@ -0,0 +1,63 @@
+<p>
+    <br/>
+    <br/>
+    <p align="center">
+    <a href="http://spectralops.io"> 
+        <img alt="SpectralOps logo" src="./logo.svg" width="300"/>
+    </a>
+    </p>
+    <p align="center">
+        <img src="https://github.com/spectralops/spectral-github-action/actions/workflows/main.yml/badge.svg"/>
+        <img src="https://img.shields.io/badge/license-MIT-brightgreen"/>
+    </p>
+    <h1>Spectral Scan</h1> 
+</p>
+
+# Install Spectral Scan action
+
+Spectral Scan is a single self-contained binary, that's easy to get and use. This action installs the latest Spectral version into your PATH.
+
+## Example usage
+
+Include this Action as a step in your workflow:
+
+```
+uses: spectral/spectral-action@v1
+with:
+  spectral-dsn: ${{ secrets.SPECTRAL_DSN }}
+```
+
+You can see an example of this Action [here](https://github.com/SpectralOps/spectral-github-action/tree/main/.github/workflows/main.yml)
+
+## Configuration
+
+You'll need to provide Spectral dsn. You can do so via the `SPECTRAL_DSN` environment variable. In the below example, the Spectral dsn is retrieved from [GitHub secrets](https://docs.github.com/en/actions/security-guides/encrypted-secrets).
+
+```yaml
+name: Example action
+
+on: [push]
+
+env:
+  SPECTRAL_DSN: ${{ secrets.SPECTRAL_DSN }}
+
+jobs:
+  my-job:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Install Spectral
+      uses: spectral/spectral-action@v1
+      with:
+        spectral-dsn: ${{ secrets.SPECTRAL_DSN }}
+    - name: Spectral Scan
+      run: spectral scan
+```
+
+### How to Contribute
+
+We welcome [issues](https://github.com/SpectralOps/spectral-github-action/issues) to and [pull requests](https://github.com/SpectralOps/spectral-github-action/pulls) against this repository!
+
+## License
+
+This project is licensed under the MIT License. See [LICENSE](LICENSE) for further details.

action.yml

@@ -0,0 +1,12 @@
+name: "Spectral Scan"
+description: "Install Spectral into your PATH"
+inputs:
+  spectral-dsn:
+    description: "Your Spectral DSN"
+    required: true
+branding:
+  icon: "download"
+  color: "purple"
+runs:
+  using: "node12"
+  main: "index.js"

index.js

@@ -0,0 +1,46 @@
+const core = require('@actions/core');
+const io = require('@actions/io');
+const tc = require('@actions/tool-cache');
+
+const workspace = process.env.GITHUB_WORKSPACE;
+const binDir = `${workspace}/bin`;
+
+main().catch(error => {
+    core.setFailed(error)
+})
+
+async function main() {
+    switch (process.platform) {
+        case 'win32':
+            await installExecutable(binDir)
+            break;
+        case 'linux':
+            await installZip(binDir, process.platform)
+            break;
+        case 'darwin':
+            await installZip(binDir, 'mac')
+            break;
+        default:
+            break;
+    }
+
+    await core.addPath(binDir)
+}
+
+async function downloadTool(platform) {
+    const spectralDsn = core.getInput('spectral-dsn')
+    const url = `${spectralDsn}/latest/dl/${platform}`
+    return await tc.downloadTool(url);
+}
+
+async function installZip(path, platform) {
+    await io.mkdirP(path);
+    const downloadPath = await downloadTool(platform)
+    await tc.extractTar(downloadPath, path)
+}
+
+async function installExecutable(path) {
+    await io.mkdirP(path);
+    const downloadPath = await downloadTool('exe')
+    await io.mv(downloadPath, `${path}/spectral.exe`)
+}