GH Action Standards

pulsar-edit · Jun 28, 2024 · d2953d7 · d2953d7
1 parent ce3ca97
commit d2953d7
Show file tree

Hide file tree

Showing 12 changed files with 259 additions and 348 deletions.
diff --git a/docs/reference/Source_Documentation.md b/docs/reference/Source_Documentation.md
@@ -651,7 +651,7 @@ function.
 * [vcs](#module_vcs)
     * [~ownership(userObj, packObj, [opts])](#module_vcs..ownership) ⇒ <code>object</code>
     * [~newPackageData(userObj, ownerRepo, service)](#module_vcs..newPackageData) ⇒ <code>object</code>
-    * [~newVersionData(userObj, ownerRepo, service)](#module_vcs..newVersionData) ⇒ [<code>SSO\_VCS\_newVersionData</code>](#SSO_VCS_newVersionData)
+    * [~newVersionData(userObj, ownerRepo, tagRef, service)](#module_vcs..newVersionData) ⇒ [<code>SSO\_VCS\_newVersionData</code>](#SSO_VCS_newVersionData)
     * [~featureDetection(userObj, ownerRepo, service)](#module_vcs..featureDetection) ⇒ <code>object</code>
     * [~determineProvider(repo)](#module_vcs..determineProvider) ⇒ <code>object</code>
 
@@ -699,7 +699,7 @@ Contains the full package data. This includes the Readme, the package.json, and
 
 <a name="module_vcs..newVersionData"></a>
 
-### vcs~newVersionData(userObj, ownerRepo, service) ⇒ [<code>SSO\_VCS\_newVersionData</code>](#SSO_VCS_newVersionData)
+### vcs~newVersionData(userObj, ownerRepo, tagRef, service) ⇒ [<code>SSO\_VCS\_newVersionData</code>](#SSO_VCS_newVersionData)
 Replaces the previously used `git.metadataAppendTarballInfo()`
 Intended to retrieve the most basic of a package's data.
 Bundles all the special handling of crafting such an object into this single
@@ -714,6 +714,7 @@ upload a new version.
 | --- | --- | --- |
 | userObj | <code>object</code> | The Full User Object as returned by `auth.verifyAuth()` |
 | ownerRepo | <code>string</code> | The Owner Repo Combo of the package affected. Such as `pulsar-edit/pulsar` |
+| tagRef | <code>string</code> | The version number or ref where data should be sought from the remote resource. |
 | service | <code>string</code> | The service to use as expected to be returned by `vcs.determineProvider()`. Currently should be hardcoded to "git" |
 
 <a name="module_vcs..featureDetection"></a>

diff --git a/docs/resources/complexity-report.md b/docs/resources/complexity-report.md
@@ -1,12 +1,12 @@
-# Complexity report, 4/13/2024
-
-* Mean per-function logical LOC: 14.905797101449275
-* Mean per-function parameter count: 0.1673913043478261
-* Mean per-function cyclomatic complexity: 1.2594202898550726
-* Mean per-function Halstead effort: 3181.0354243656466
-* Mean per-module maintainability index: 67.98276367366883
-* First-order density: 0.7141356857802983%
-* Change cost: 4.452846040747742%
+# Complexity report, 6/28/2024
+
+* Mean per-function logical LOC: 15.104166666666666
+* Mean per-function parameter count: 0.16041666666666668
+* Mean per-function cyclomatic complexity: 1.2486111111111111
+* Mean per-function Halstead effort: 3138.7585527439614
+* Mean per-module maintainability index: 67.69225045749998
+* First-order density: 0.6558641975308641%
+* Change cost: 4.147376543209877%
 * Core size: 100%
 
 ## /home/runner/work/package-backend/package-backend/jest.config.js
@@ -281,7 +281,7 @@
 
 ## /home/runner/work/package-backend/package-backend/src/models/callStack.js
 
-* Physical LOC: 83
+* Physical LOC: 94
 * Logical LOC: 2
 * Mean parameter count: 0
 * Cyclomatic complexity: 1
@@ -909,6 +909,36 @@
 * Maintainability index: 71.71259723250154
 * Dependency count: 0
 
+## /home/runner/work/package-backend/package-backend/tests/full/fixtures/d-pulsar-package/initial-tags.js
+
+* Physical LOC: 11
+* Logical LOC: 6
+* Mean parameter count: 0
+* Cyclomatic complexity: 1
+* Cyclomatic complexity density: 16.666666666666664%
+* Maintainability index: 71.71259723250154
+* Dependency count: 0
+
+## /home/runner/work/package-backend/package-backend/tests/full/fixtures/d-pulsar-package/match.js
+
+* Physical LOC: 50
+* Logical LOC: 42
+* Mean parameter count: 0
+* Cyclomatic complexity: 1
+* Cyclomatic complexity density: 2.380952380952381%
+* Maintainability index: 47.396064939782065
+* Dependency count: 0
+
+## /home/runner/work/package-backend/package-backend/tests/full/fixtures/d-pulsar-package/tags.js
+
+* Physical LOC: 20
+* Logical LOC: 11
+* Mean parameter count: 0
+* Cyclomatic complexity: 1
+* Cyclomatic complexity density: 9.090909090909092%
+* Maintainability index: 63.92267728456596
+* Dependency count: 0
+
 ## /home/runner/work/package-backend/package-backend/scripts/deprecated/test/handlers/common_handler/express_fakes.js
 
 * Physical LOC: 26

diff --git a/docs/swagger/openapi3_def.yaml b/docs/swagger/openapi3_def.yaml
@@ -679,13 +679,12 @@ paths:
         - $ref: '#/components/parameters/rename'
         - $ref: '#/components/parameters/auth'
         - $ref: '#/components/parameters/packageName'
+        - $ref: '#/components/parameters/tag'
       responses:
         '201':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/packageObjectFull'
-          description: The package details indicating success.
+          description: >-
+            An object with a key 'message' indicating what version has been
+            published.
       summary: Creates a new package version.
   /api/packages/{packageName}/versions/{versionName}:
     delete:
@@ -1029,13 +1028,12 @@ paths:
         - $ref: '#/components/parameters/rename'
         - $ref: '#/components/parameters/auth'
         - $ref: '#/components/parameters/packageName'
+        - $ref: '#/components/parameters/tag'
       responses:
         '201':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/packageObjectFull'
-          description: The package details indicating success.
+          description: >-
+            An object with a key 'message' indicating what version has been
+            published.
       summary: Creates a new package version.
   /api/themes/{packageName}/versions/{versionName}:
     delete: