fix: enable paths in usage

glungley · glungley · commit 13f62349cf80 · 2024-07-09T17:39:36.000+01:00
diff --git a/__tests__/fixtures/action/action_deprecated.output b/__tests__/fixtures/action/action_deprecated.output
@@ -12,7 +12,7 @@ Default test
 ### Usage
 
 ```yaml
-- uses: npalm/action-docs@v1
+- uses: npalm/action-docs/__tests__/fixtures/action/all_fields_action.yml@v1
   with:
     inputA:
     # A description A
diff --git a/__tests__/fixtures/action/action_usage_readme.output b/__tests__/fixtures/action/action_usage_readme.output
@@ -2,7 +2,7 @@
 ## Usage
 
 ```yaml
-- uses: npalm/action-docs@v1
+- uses: npalm/action-docs/__tests__/fixtures/action/action.yml@v1
   with:
     inputA:
     # - Item 1
diff --git a/__tests__/fixtures/action/all_fields_action.output b/__tests__/fixtures/action/all_fields_action.output
@@ -28,7 +28,7 @@ This action is a `node12` action.
 ## Usage
 
 ```yaml
-- uses: ***PROJECT***@***VERSION***
+- uses: ***PROJECT******SOURCE_FILE***@***VERSION***
   with:
     inputA:
     # A description A
diff --git a/__tests__/fixtures/action/all_fields_action_toc3_cli.output b/__tests__/fixtures/action/all_fields_action_toc3_cli.output
@@ -28,7 +28,7 @@ This action is a `node12` action.
 ### Usage
 
 ```yaml
-- uses: ***PROJECT***@***VERSION***
+- uses: ***PROJECT******SOURCE_FILE***@***VERSION***
   with:
     inputA:
     # A description A
diff --git a/__tests__/fixtures/action/all_fields_one_annotation.output b/__tests__/fixtures/action/all_fields_one_annotation.output
@@ -29,7 +29,7 @@ This action is a `node12` action.
 ## Usage
 
 ```yaml
-- uses: npalm/action-docs@v1
+- uses: npalm/action-docs/__tests__/fixtures/action/all_fields_action.yml@v1
   with:
     inputA:
     # A description A
diff --git a/__tests__/fixtures/action/all_fields_readme.output b/__tests__/fixtures/action/all_fields_readme.output
@@ -12,7 +12,7 @@ Default test
 ### Usage
 
 ```yaml
-- uses: npalm/action-docs@v1
+- uses: npalm/action-docs/__tests__/fixtures/action/all_fields_action.yml@v1
   with:
     inputA:
     # A description A
diff --git a/__tests__/fixtures/action/all_fields_usage_readme.output b/__tests__/fixtures/action/all_fields_usage_readme.output
@@ -2,7 +2,7 @@
 ## Usage
 
 ```yaml
-- uses: npalm/action-docs@v1
+- uses: npalm/action-docs/__tests__/fixtures/action/all_fields_action.yml@v1
   with:
     inputA:
     # A description A
diff --git a/__tests__/fixtures/action/default-with-header.output b/__tests__/fixtures/action/default-with-header.output
@@ -26,7 +26,7 @@ This action is a `node12` action.
 ### Usage
 
 ```yaml
-- uses: ***PROJECT***@***VERSION***
+- uses: ***PROJECT******SOURCE_FILE***@***VERSION***
   with:
     inputA:
     # - Item 1
diff --git a/__tests__/fixtures/action/default.output b/__tests__/fixtures/action/default.output
@@ -24,7 +24,7 @@ This action is a `node12` action.
 ## Usage
 
 ```yaml
-- uses: ***PROJECT***@***VERSION***
+- uses: ***PROJECT******SOURCE_FILE***@***VERSION***
   with:
     inputA:
     # - Item 1
diff --git a/__tests__/fixtures/action/minimal_action.output b/__tests__/fixtures/action/minimal_action.output
@@ -9,7 +9,7 @@ This action is a `docker` action.
 ## Usage
 
 ```yaml
-- uses: ***PROJECT***@***VERSION***
+- uses: ***PROJECT******SOURCE_FILE***@***VERSION***
 ```
 
 
diff --git a/__tests__/fixtures/workflow/all_fields_one_annotation.output b/__tests__/fixtures/workflow/all_fields_one_annotation.output
@@ -25,7 +25,7 @@
 ```yaml
 jobs:
   job1:
-    uses: npalm/action-docs@v1
+    uses: npalm/action-docs/__tests__/fixtures/workflow/all_fields_workflow.yml@v1
     with:
       inputA:
       # A description A
diff --git a/__tests__/fixtures/workflow/all_fields_readme.output b/__tests__/fixtures/workflow/all_fields_readme.output
@@ -8,7 +8,7 @@
 ```yaml
 jobs:
   job1:
-    uses: npalm/action-docs@v1
+    uses: npalm/action-docs/__tests__/fixtures/workflow/all_fields_workflow.yml@v1
     with:
       inputA:
       # A description A
diff --git a/__tests__/fixtures/workflow/all_fields_usage_readme.output b/__tests__/fixtures/workflow/all_fields_usage_readme.output
@@ -4,7 +4,7 @@
 ```yaml
 jobs:
   job1:
-    uses: npalm/action-docs@v1
+    uses: npalm/action-docs/__tests__/fixtures/workflow/all_fields_workflow.yml@v1
     with:
       inputA:
       # A description A
diff --git a/__tests__/fixtures/workflow/all_fields_workflow.output b/__tests__/fixtures/workflow/all_fields_workflow.output
@@ -24,7 +24,7 @@
 ```yaml
 jobs:
   job1:
-    uses: ***PROJECT***@***VERSION***
+    uses: ***PROJECT******SOURCE_FILE***@***VERSION***
     with:
       inputA:
       # A description A
diff --git a/__tests__/fixtures/workflow/default.output b/__tests__/fixtures/workflow/default.output
@@ -20,7 +20,7 @@
 ```yaml
 jobs:
   job1:
-    uses: ***PROJECT***@***VERSION***
+    uses: ***PROJECT******SOURCE_FILE***@***VERSION***
     with:
       inputA:
       # - Item 1
diff --git a/__tests__/fixtures/workflow/minimal_workflow.output b/__tests__/fixtures/workflow/minimal_workflow.output
@@ -5,7 +5,7 @@
 ```yaml
 jobs:
   job1:
-    uses: ***PROJECT***@***VERSION***
+    uses: ***PROJECT******SOURCE_FILE***@***VERSION***
 ```
 
 
diff --git a/__tests__/fixtures/workflow/workflow_usage_readme.output b/__tests__/fixtures/workflow/workflow_usage_readme.output
@@ -4,7 +4,7 @@
 ```yaml
 jobs:
   job1:
-    uses: npalm/action-docs@v1
+    uses: npalm/action-docs/__tests__/fixtures/workflow/workflow.yml@v1
     with:
       inputA:
       # - Item 1
diff --git a/package.json b/package.json
@@ -75,5 +75,6 @@
   "homepage": "https://github.com/npalm/action-docs#readme",
   "directories": {
     "dist": "lib"
-  }
+  },
+  "packageManager": "yarn@1.22.22+sha512.a6b2f7906b721bba3d67d4aff083df04dad64c399707841b7acf00f6b133b7ac24255f2652fa22ae3534329dc6180534e98d17432037ff6fd140556e2bb3137e"
 }
diff --git a/src/action-docs.ts b/src/action-docs.ts
@@ -125,14 +125,14 @@ function createMdCodeBlock(
   let indent = "";
 
   if (isAction) {
-    codeBlockArray.push("- uses: ***PROJECT***@***VERSION***");
+    codeBlockArray.push("- uses: ***PROJECT******SOURCE_FILE***@***VERSION***");
     indent += "  ";
   } else {
     codeBlockArray.push("jobs:");
     indent += "  ";
     codeBlockArray.push(`${indent}job1:`);
     indent += "  ";
-    codeBlockArray.push(`${indent}uses: ***PROJECT***@***VERSION***`);
+    codeBlockArray.push(`${indent}uses: ***PROJECT******SOURCE_FILE***@***VERSION***`);
   }
 
   const inputs = getInputOutput(
@@ -352,6 +352,9 @@ async function updateReadme(
       .replace(
         "***VERSION***",
         matchProjectVersion ? matchProjectVersion[2] : "",
+      ).replace(
+        "***SOURCE_FILE***",
+        sourceFile !== defaultOptions.sourceFile ? `/${sourceFile}` : "",
       );
 
     await replaceInFile.replaceInFile({
@@ -377,8 +380,8 @@ function createMarkdownSection(
   return data === "" || data === undefined
     ? ""
     : `${createMarkdownHeader(options, header)}${data}` +
-        `${lineBreak}` +
-        `${lineBreak}`;
+    `${lineBreak}` +
+    `${lineBreak}`;
 }
 
 function createMarkdownHeader(options: DefaultOptions, header: string): string {
