[email protected]

.github/workflows/validate.yml

@@ -10,10 +10,8 @@ on:
 
   # Allows you to run this workflow manually from the Actions tab
   workflow_dispatch:
-
 concurrency:
-  group: ${{ github.ref }}
-
+  group: ${{ github.workflow }}-${{ github.ref }}
 jobs:
   validate:
     runs-on: ${{ matrix.os }}
@@ -23,14 +21,13 @@ jobs:
         os: [ macos-latest, windows-latest, ubuntu-latest ]
 
     steps:
-      - name: checkout self
-        uses: actions/checkout@v4
+      - uses: actions/checkout@v4
 
       - name: RageAgainstThePixel/upm-config
         uses: ./
         with:
-          registry_url: ${{ secrets.UPM_REGISTRY_URL }}
-          auth_token: ${{ secrets.UPM_AUTH_TOKEN }}
+          registry-url: ${{ secrets.UPM_REGISTRY_URL }}
+          auth-token: ${{ secrets.UPM_AUTH_TOKEN }}
 
       - run: |
           # macOS and Linux '~/.upmconfig.toml'
@@ -54,7 +51,7 @@ jobs:
       - name: RageAgainstThePixel/upm-config
         uses: ./
         with:
-          registry_url: ${{ secrets.UPM_REGISTRY_URL }}
+          registry-url: ${{ secrets.UPM_REGISTRY_URL }}
           username: ${{ secrets.UPM_USERNAME }}
           password: ${{ secrets.UPM_PASSWORD }}
 

README.md

@@ -1,27 +1,26 @@
 # upm-config
 
-A GitHub action for setting Unity UPM private scoped registry credentials.
+A GitHub Action for setting Unity Engine UPM private scoped registry credentials in CI/CD workflows.
 
 ## How to use
 
 ### workflow
 
 ```yaml
 steps:
-  - uses: RageAgainstThePixel/upm-config@v1
+  - uses: RageAgainstThePixel/upm-config@v2
     with:
-      registry_url: 'http://upm.registry.com:4873'
+      registry-url: 'http://upm.registry.com:4873'
       username: ${{ secrets.UPM_USERNAME }}
       password: ${{ secrets.UPM_PASSWORD }}
-
 ```
 
 ### inputs
 
 | name | description | required |
 | ---- | ----------- | -------- |
-| registry_url | The URL of the private scoped registry. | true |
-| auth_token | The authentication token for the private scoped registry. | Required if username and password are not provided. |
-| username | The username for the private scoped registry. | Required if auth_token is not provided. |
-| password | The password for the private scoped registry. | Required if auth_token is not provided. |
-| always_auth | Whether to always authenticate with the private scoped registry. Defaults to true. | false |
+| `registry-url` | The URL of the private scoped registry. | true |
+| `auth-token` | The authentication token for the private scoped registry. | Required if username and password are not provided. |
+| `username` | The username for the private scoped registry. | Required if auth-token is not provided. |
+| `password` | The password for the private scoped registry. | Required if auth-token is not provided. |
+| `always-auth` | Whether to always authenticate with the private scoped registry. Defaults to `true`. | false |

action.yaml

@@ -1,11 +1,11 @@
 name: 'upm-config'
-description: 'A GitHub action for setting Unity UPM private scoped registry configurations.'
+description: 'A GitHub Action for setting Unity UPM private scoped registry configurations in CI/CD workflows.'
 
 inputs:
-  registry_url:
+  registry-url:
     description: 'The URL of the private scoped registry.'
     required: true
-  auth_token:
+  auth-token:
     description: 'The authentication token for the private scoped registry. Required if username and password are not provided.'
     required: false
   username:
@@ -14,7 +14,7 @@ inputs:
   password:
     description: 'The password for the private scoped registry. Required if auth_token is not provided.'
     required: false
-  always_auth:
+  always-auth:
     description: 'Whether to always authenticate with the private scoped registry. Defaults to true.'
     required: false
     default: 'true'

dist/index.js

@@ -26156,8 +26156,8 @@ const path = __nccwpck_require__(1017);
 const fs = __nccwpck_require__(3292);
 
 async function Run() {
-    const registry_url = core.getInput('registry_url', { required: true });
-    let auth_token = core.getInput('auth_token');
+    const registry_url = core.getInput('registry-url', { required: true });
+    let auth_token = core.getInput('auth-token');
     if (!auth_token) {
         const username = core.getInput('username', { required: true });
         const password = core.getInput('password', { required: true });
@@ -26245,7 +26245,7 @@ async function save_upm_config(registry_url, auth_token) {
     }
     const upm_config_toml = await fs.readFile(upm_config_toml_path, 'utf-8');
     if (!upm_config_toml.includes(registry_url)) {
-        const alwaysAuth = core.getInput('alwaysAuth') === 'true';
+        const alwaysAuth = core.getInput('always-auth') === 'true';
         await fs.appendFile(upm_config_toml_path, `registry_url = "${registry_url}"\nauth_token = "${auth_token}"\nalwaysAuth = ${alwaysAuth}\n`);
     }
 }
@@ -28185,6 +28185,7 @@ const main = async () => {
         await upm_config.Run();
     } catch (error) {
         core.setFailed(error);
+        process.exit(1);
     }
 }
 

package.json

@@ -1,13 +1,13 @@
 {
   "name": "upm-config",
-  "version": "1.0.0",
-  "description": "A GitHub action for setting Unity UPM private scoped registry credentials.",
+  "version": "2.0.0",
+  "description": "A GitHub action for setting Unity UPM private scoped registry credentials in CI/CD workflows.",
   "author": "RageAgainstThePixel",
+  "license": "MIT",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/RageAgainstThePixel/upm-config.git"
   },
-  "license": "MIT",
   "bugs": {
     "url": "https://github.com/RageAgainstThePixel/upm-config/issues"
   },

src/index.js

@@ -6,6 +6,7 @@ const main = async () => {
         await upm_config.Run();
     } catch (error) {
         core.setFailed(error);
+        process.exit(1);
     }
 }
 

src/upm_config.js

@@ -4,8 +4,8 @@ const path = require('path');
 const fs = require('fs/promises');
 
 async function Run() {
-    const registry_url = core.getInput('registry_url', { required: true });
-    let auth_token = core.getInput('auth_token');
+    const registry_url = core.getInput('registry-url', { required: true });
+    let auth_token = core.getInput('auth-token');
     if (!auth_token) {
         const username = core.getInput('username', { required: true });
         const password = core.getInput('password', { required: true });
@@ -93,7 +93,7 @@ async function save_upm_config(registry_url, auth_token) {
     }
     const upm_config_toml = await fs.readFile(upm_config_toml_path, 'utf-8');
     if (!upm_config_toml.includes(registry_url)) {
-        const alwaysAuth = core.getInput('alwaysAuth') === 'true';
+        const alwaysAuth = core.getInput('always-auth') === 'true';
         await fs.appendFile(upm_config_toml_path, `registry_url = "${registry_url}"\nauth_token = "${auth_token}"\nalwaysAuth = ${alwaysAuth}\n`);
     }
 }