Merge pull request #4 from seek-oss/namespace-var-names

Namespace var names

Author: mr-beerkiss

.buildkite/pipeline.yml

@@ -0,0 +1,11 @@
+name: Buildkite plugins test actions
+on: push
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Lint
+        run: docker-compose run lint
+      - name: Tests
+        run: docker-compose run tests

.github/workflows/main.yml

@@ -1,4 +1,8 @@
-# Private NPM Buildkite Plugin [![Build status](https://badge.buildkite.com/705414e5df1533fbc18a2dda1305ec015282575a87edb1e0c1.svg)](https://buildkite.com/seek/private-npm-buildkite-plugin)
+# Private NPM Buildkite Plugin
+
+[![Build Status](https://img.shields.io/endpoint.svg?url=https%3A%2F%2Factions-badge.atrox.dev%2Fseek-oss%2Fprivate-npm-buildkite-plugin%2Fbadge&style=flat)](https://actions-badge.atrox.dev/seek-oss/private-npm-buildkite-plugin/goto)
+[![GitHub Release](https://img.shields.io/github/release/seek-oss/private-npm-buildkite-plugin.svg)](https://github.com/seek-oss/private-npm-buildkite-plugin/releases)
+
 
 A [Buildkite plugin](https://buildkite.com/docs/agent/v3/plugins) to allow pipeline steps to easily install
 private packages from an [npm](https://www.npmjs.com) repository.
@@ -13,7 +17,7 @@ To read the value from an environment variable named `MY_TOKEN` when the plugin
 steps:
   - command: yarn install
     plugins:
-      - seek-oss/private-npm#v1.1.1:
+      - seek-oss/private-npm#v1.1.2:
           env: "MY_TOKEN"
 ```
 
@@ -23,7 +27,7 @@ To read the value from a file named `my_token_file`, use the `file` field.
 steps:
   - command: yarn install
     plugins:
-      - seek-oss/private-npm#v1.1.1:
+      - seek-oss/private-npm#v1.1.2:
           file: "my_token_file"
 ```
 
@@ -35,7 +39,7 @@ approach is discoraged in favour of using with the `env` or `file` fields.  This
 steps:
   - command: yarn install
     plugins:
-      - seek-oss/private-npm#v1.1.1:
+      - seek-oss/private-npm#v1.1.2:
           token: ${MY_TOKEN}
 ```
 
@@ -46,7 +50,7 @@ You can also specify a custom npm registry if you are using your own mirror.
 steps:
   - command: yarn install
     plugins:
-      - seek-oss/private-npm#v1.1.1:
+      - seek-oss/private-npm#v1.1.2:
           env: "MY_TOKEN"
           registry: //myprivatenpm.com/
 ```
@@ -62,6 +66,9 @@ The value of the NPM token will be read from the agent environment when the plug
 around cases where eager binding of variables in `pipeline.yml` means some variables are not present in the 
 environment when the configuration file is parsed.
 
+> **NOTE** : Beware of using `NPM_TOKEN` as the name for the environment variable. When using that name the variable
+> is unstable and has a tedency to return an empty string in the context of this plugin.
+
 ### `file` (optional)
 
 The value of the NPM token will be read from a file on the agent when the plugin executes.  This is useful when working

README.md

@@ -3,4 +3,9 @@ services:
   tests:
     image: buildkite/plugin-tester
     volumes:
-      - ".:/plugin"
+      - ".:/plugin"
+  lint:
+    image: buildkite/plugin-linter
+    command: ['--name', 'seek-oss/private-npm']
+    volumes:
+      - ".:/plugin:ro"

docker-compose.yml

@@ -2,28 +2,28 @@
 set -euo pipefail
 IFS=$'\n\t'
 
-REGISTRY=${BUILDKITE_PLUGIN_PRIVATE_NPM_REGISTRY:-'//registry.npmjs.org/'}
-TOKEN=${BUILDKITE_PLUGIN_PRIVATE_NPM_TOKEN:-''}
-FILE=${BUILDKITE_PLUGIN_PRIVATE_NPM_FILE:-''}
-ENV=${BUILDKITE_PLUGIN_PRIVATE_NPM_ENV:-''}
+SEEK_OSS_PRIVATE_NPM_REGISTRY=${BUILDKITE_PLUGIN_PRIVATE_NPM_REGISTRY:-'//registry.npmjs.org/'}
+SEEK_OSS_PRIVATE_NPM_TOKEN=${BUILDKITE_PLUGIN_PRIVATE_NPM_TOKEN:-''}
+SEEK_OSS_PRIVATE_NPM_FILE=${BUILDKITE_PLUGIN_PRIVATE_NPM_FILE:-''}
+SEEK_OSS_PRIVATE_NPM_ENV=${BUILDKITE_PLUGIN_PRIVATE_NPM_ENV:-''}
 
-if { [[ -n "${FILE}" ]] && [[ -n "${ENV}" ]]; } \
-  || { [[ -n "${FILE}" ]] && [[ -n "${TOKEN}" ]]; } \
-  || { [[ -n "${TOKEN}" ]] && [[ -n "${ENV}" ]]; }
+if { [[ -n "${SEEK_OSS_PRIVATE_NPM_FILE}" ]] && [[ -n "${SEEK_OSS_PRIVATE_NPM_ENV}" ]]; } \
+  || { [[ -n "${SEEK_OSS_PRIVATE_NPM_FILE}" ]] && [[ -n "${SEEK_OSS_PRIVATE_NPM_TOKEN}" ]]; } \
+  || { [[ -n "${SEEK_OSS_PRIVATE_NPM_TOKEN}" ]] && [[ -n "${SEEK_OSS_PRIVATE_NPM_ENV}" ]]; }
 then
   echo ':no_entry_sign: :npm: :package: Failed! Only one of file, env or token parameters may be set'
   exit 1
 fi
 
-if [[ -n "${FILE}" ]]
+if [[ -n "${SEEK_OSS_PRIVATE_NPM_FILE}" ]]
 then
-  TOKEN=$(cat "${FILE}")
-elif [[ -n "${ENV}" ]]
+  SEEK_OSS_PRIVATE_NPM_TOKEN=$(cat "${SEEK_OSS_PRIVATE_NPM_FILE}")
+elif [[ -n "${SEEK_OSS_PRIVATE_NPM_ENV}" ]]
 then
-  TOKEN="${!ENV}"
+  SEEK_OSS_PRIVATE_NPM_TOKEN="${!SEEK_OSS_PRIVATE_NPM_ENV}"
 fi
 
-if [[ -z $TOKEN ]] 
+if [[ -z $SEEK_OSS_PRIVATE_NPM_TOKEN ]] 
 then
   echo ':no_entry_sign: :npm: :package: Failed! A valid NPM_TOKEN could not be determined'
   exit 1
@@ -32,6 +32,6 @@ fi
 echo '--- Setting up access for :no_entry_sign: :npm: :package:'
 
 cat > .npmrc << EOF
-${REGISTRY}:_authToken=${TOKEN}
+${SEEK_OSS_PRIVATE_NPM_REGISTRY}:_authToken=${SEEK_OSS_PRIVATE_NPM_TOKEN}
 save-exact=true
 EOF