Aligns Action with common format (#13)

* updates workflows

* updates README

* adds support for `copywrite`

* cleans up dependencies

Author: ksatirli

.copywrite.hcl

@@ -1,7 +1,15 @@
+# Copyright (c) HashiCorp, Inc.
+# SPDX-License-Identifier: Apache-2.0
+
 schema_version = 1
 
 project {
-  header_ignore = [
-    "dist/index.js"
+    license          = "Apache-2.0"
+    copyright_holder = "HashiCorp, Inc."
+    copyright_year   = 2022
+
+    header_ignore = [
+        "dist/*",
+        "node_modules/",
   ]
 }

.github/workflows/actions-self-test.yml

@@ -4,8 +4,8 @@ on:
   push:
 
 env:
-  PRODUCT_VERSION: "0.0.1-techpreview.3"
-  PRODUCT_HASH: "3b4163b"
+  PRODUCT_VERSION: "0.1.1"
+  PRODUCT_HASH: "5159a77"
 
 jobs:
   setup-nomad-pack:
@@ -14,7 +14,7 @@ jobs:
 
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup `nomad-pack` (using local GitHub Action)
         uses: "./"

.github/workflows/compliance.yml

@@ -0,0 +1,25 @@
+---
+
+name: "HashiCorp: Compliance"
+
+on:
+  push:
+
+permissions:
+  contents: read
+
+jobs:
+  copywrite:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f # v4.1.3
+        with:
+          # Full git history is needed to get a proper list of changed files within `super-linter`
+          fetch-depth: 0
+
+      - uses: hashicorp/setup-copywrite@867a1a2a064a0626db322392806428f7dc59cb3e # v1.1.2
+
+      - run: copywrite headers --plan
+
+      - run: copywrite license --plan

.github/workflows/snyk.yml

@@ -1,4 +1,5 @@
 ---
+
 name: "Code Quality: Super-Linter"
 
 on:
@@ -10,13 +11,13 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
+        uses: actions/checkout@1d96c772d19495a3b5c517cd2bc0cb401ea0529f # v4.1.3
         with:
           # Full git history is needed to get a proper list of changed files within `super-linter`
           fetch-depth: 0
 
       - name: Lint Code with Super-Linter
-        uses: github/super-linter@45fc0d88288beee4701c62761281edfee85655d7 # v5.0.0
+        uses: github/super-linter/slim@45fc0d88288beee4701c62761281edfee85655d7 # v5.0.0
         env:
           VALIDATE_ALL_CODEBASE: true
           DEFAULT_BRANCH: "main"

.github/workflows/superlinter.yml

@@ -9,6 +9,9 @@ jobs:
     name: Node.js
     runs-on: ubuntu-latest
 
+    env:
+      PACKAGES: "@vercel/ncc prettier"
+
     strategy:
       # see https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstrategyfail-fast
       fail-fast: false
@@ -18,18 +21,24 @@ jobs:
 
     steps:
       - name: Checkout Repository
-        uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # v3.5.3
+        uses: actions/checkout@3df4ab11eba7bda6032a0b82a6bb43b11571feac # v4.0.0
         with:
           fetch-depth: 1
 
       - name: Set up Node.js
-        uses: actions/setup-node@e33196f7422957bea03ed53f6fbb155025ffc7b8 # v3.7.0
+        uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # v4.0.2
         with:
           node-version: ${{ matrix.node-version }}
           cache: 'npm'
 
-      - name: Install NPM Packages
-        run: npm ci
+      - name: Install global NPM packages
+        run: npm install --global ${PACKAGES}
+
+      - name: Install Action-specific NPM Packages
+        run: npm install-clean
 
       - name: Build TypeScript code
-        run: npm run build
+        run: |
+          npm run-script fmt \
+          && \
+          npm run-script build

.github/workflows/typescript.yml

@@ -7,7 +7,7 @@ The `hashicorp/setup-nomad-pack` Action sets up the [Nomad Pack](https://develop
 ## Table of Contents
 
 <!-- TOC -->
-* [GitHub Action: `setup-nomad-pack`](#github-action--setup-nomad-pack)
+* [GitHub Action: `setup-nomad-pack`](#github-action-setup-nomad-pack)
   * [Table of Contents](#table-of-contents)
   * [Requirements](#requirements)
   * [Usage](#usage)
@@ -35,7 +35,7 @@ Other [environment variables](https://developer.hashicorp.com/nomad/docs/command
 Optionally, set any and all [environment variables](https://developer.hashicorp.com/nomad/docs/commands#environment-variables) as required for your Nomad cluster.
 
 > **Warning**
-> Running services such as Nomad on a publicly accessible port without authentication is a decidedly bad idea.
+> Running services such as Nomad on a publicly accessible port without authentication may be harmful.
 >
 > Consult with your security team to define an access policy that meets your organization's security demands.
 
@@ -48,21 +48,21 @@ This data may be retrieved through [HashiCorp Terraform](https://terraform.io/),
 name: nomad-pack
 
 on:
-  - push
+  push:
 
 env:
-  PRODUCT_VERSION: "0.0.1-techpreview.3"
+  PRODUCT_VERSION: "0.1.1"
 
 jobs:
   setup-nomad-pack:
     runs-on: ubuntu-latest
     name: Run Nomad Pack
     steps:
       - name: Checkout
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
 
       - name: Setup `nomad-pack`
-        uses: hashicorp/setup-nomad-pack@v1.0.0
+        uses: hashicorp/setup-nomad-pack@main
         id: setup
         with:
           version: ${{ env.PRODUCT_VERSION }}
@@ -87,8 +87,8 @@ jobs:
 In the above example, the following definitions have been set.
 
 - The event trigger has been set to `push`. For a complete list, see [Events that trigger workflows](https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows).
-- The origin of this GitHub Action has been set as `hashicorp/setup-nomad-pack@1.0.0`. For newer versions, see the [Releases](https://github.com/hashicorp/setup-nomad-pack/releases).
-- The version of `nomad-pack` to set up has been set as `0.0.1-techpreview.3`. For a complete list, see [releases.hashicorp.com](https://releases.hashicorp.com/nomad-pack/).
+- The origin of this GitHub Action has been set as `hashicorp/setup-nomad-pack@main`. For newer versions, see the [Releases](https://github.com/hashicorp/setup-nomad-pack/releases).
+- The version of `nomad-pack` to set up has been set as `0.1.1`. For a complete list, see [releases.hashicorp.com](https://releases.hashicorp.com/nomad-pack/).
 - The pack to interact with has been set to `./test`
 
 These definitions may require updating to suit your deployment, such as specifying [self-hosted](https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#choosing-self-hosted-runners) runners.
@@ -111,8 +111,6 @@ This section contains a list of all outputs that can be consumed from this Actio
 
 This GitHub Action is maintained by the contributors listed on [GitHub](https://github.com/hashicorp/setup-nomad-pack/graphs/contributors).
 
-The original code of this repository is based on work done by [Matthew Sanabria](https://github.com/sudomateo) as part of the [setup-packer](https://github.com/sudomateo/setup-packer) GitHub Action.
-
 ## License
 
 Licensed under the Apache License, Version 2.0 (the "License").

.snyk

@@ -39,8 +39,10 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
     });
 };
 Object.defineProperty(exports, "__esModule", ({ value: true }));
+exports.PRODUCT = void 0;
 const core = __importStar(__nccwpck_require__(6024));
 const hc = __importStar(__nccwpck_require__(2999));
+exports.PRODUCT = "nomad-pack";
 function main() {
     return __awaiter(this, void 0, void 0, function* () {
         const version = core.getInput("version");
@@ -49,7 +51,7 @@ function main() {
             return;
         }
         try {
-            yield hc.getHashicorpRelease("nomad-pack", version);
+            yield hc.getHashicorpRelease(exports.PRODUCT, version);
         }
         catch (error) {
             if (error instanceof Error) {
@@ -620,7 +622,7 @@ class OidcClient {
                 .catch(error => {
                 throw new Error(`Failed to get ID Token. \n 
         Error Code : ${error.statusCode}\n 
-        Error Message: ${error.result.message}`);
+        Error Message: ${error.message}`);
             });
             const id_token = (_a = res.result) === null || _a === void 0 ? void 0 : _a.value;
             if (!id_token) {