Rename bin command

.github/workflows/docker.yml

@@ -0,0 +1,30 @@
+# For details of what checks are run for PRs please refer below
+# docs: https://docs.github.com/en/actions/reference/workflow-syntax-for-github-actions
+
+name: Docker CI
+
+on: 
+  push:
+    branches: ["master"]
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test:
+    name: Build and test docker image
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    env:
+      DOCKER_TAG: 'cdx-node-module-testing:${{ github.run_id }}.${{ github.run_number }}.${{ github.run_attempt }}'
+    steps:
+      - name: Checkout
+        # see https://github.com/actions/checkout
+        uses: actions/checkout@v2.4.0
+      - name: Build Docker image
+        run: docker build -f Dockerfile -t "$DOCKER_TAG" .
+      - name: Test Docker image
+        run: docker run --rm "$DOCKER_TAG" -h
+      - name: Destroy Docker image
+        # run regardless of outcome
+        if: ${{ always() }}
+        run: docker rmi -f "$DOCKER_TAG"

.github/workflows/nodejs.yml

@@ -14,7 +14,7 @@ env:
   CI: "true"
 
 jobs:
-  build:
+  test:
     name: Test (node${{ matrix.node-version }}, ${{ matrix.os }})
     timeout-minutes: 30
     runs-on: ${{ matrix.os }}

Dockerfile

@@ -17,5 +17,5 @@ RUN npm ci --only=production
 
 COPY . /usr/src/cyclonedx-bom
 
-ENTRYPOINT ["/usr/src/cyclonedx-bom/bin/cyclonedx-bom"]
+ENTRYPOINT ["/usr/src/cyclonedx-bom/bin/make-bom.js"]
 CMD ["-h"]

HISTORY.md

@@ -4,6 +4,14 @@ All notable changes to this project will be documented in this file.
 
 ## unreleased
 
+* Changed
+  * Renamed `bin/cyclonedx-bom` to `bin/make-bom.js` (via [#216])  
+    This is considered a none-breaking change,
+    as the CLI use of `npx cyclonedx-node`/`npx cyclonedx-bom`
+    is untouched.
+
+[#216]: https://github.com/CycloneDX/cyclonedx-node-module/pull/216
+
 ## 3.2.0
 
 * Added

bin/cyclonedx-bom → bin/make-bom.js

@@ -1,4 +1,6 @@
 #!/usr/bin/env node
+/* eslint-env node */
+
 /*
  * This file is part of CycloneDX Node Module.
  *

package.json

@@ -34,12 +34,12 @@
   ],
   "main": "index.js",
   "bin": {
-    "cyclonedx-bom": "./bin/cyclonedx-bom",
-    "cyclonedx-node": "./bin/cyclonedx-bom"
+    "cyclonedx-bom": "./bin/make-bom.js",
+    "cyclonedx-node": "./bin/make-bom.js"
   },
   "scripts": {
     "test": "jest",
-    "docker-release": "docker build . -t cyclonedx/cyclonedx-node:`node bin/cyclonedx-bom --version` -t cyclonedx/cyclonedx-node:latest && docker push cyclonedx/cyclonedx-node:`node bin/cyclonedx-bom --version` && docker push cyclonedx/cyclonedx-node:latest"
+    "docker-release": "docker build . -t cyclonedx/cyclonedx-node:`node bin/make-bom.js --version` -t cyclonedx/cyclonedx-node:latest && docker push cyclonedx/cyclonedx-node:`node bin/make-bom.js --version` && docker push cyclonedx/cyclonedx-node:latest"
   },
   "engines": {
     "node": ">=12.0.0"

tests/no-lockfile/package.json

@@ -29,9 +29,6 @@
     }
   ],
   "main": "index.js",
-  "bin": {
-    "cyclonedx-bom": "./bin/cyclonedx-bom"
-  },
   "scripts": {
     "test": "echo \"Warning: no test specified\" && exit 0"
   },

tests/with-lockfile-2/package.json

@@ -29,9 +29,6 @@
     }
   ],
   "main": "index.js",
-  "bin": {
-    "cyclonedx-bom": "./bin/cyclonedx-bom"
-  },
   "scripts": {
     "test": "echo \"Warning: no test specified\" && exit 0"
   },

tests/with-packages/package.json

@@ -29,9 +29,6 @@
     }
   ],
   "main": "index.js",
-  "bin": {
-    "cyclonedx-bom": "./bin/cyclonedx-bom"
-  },
   "scripts": {
     "test": "echo \"Warning: no test specified\" && exit 0"
   },