feat: report is generated separately for each workingDirectory

Author: MH4GF

action.yml

@@ -34,3 +34,4 @@ runs:
         INPUT_TARGET_FILES: ${{ steps.changed-files.outputs.all_changed_files }}
         INPUT_CONFIG_FILE: ${{ inputs.config-file }}
         INPUT_CRUISE_SCRIPT: ${{ inputs.cruise-script }}
+        INPUT_WORKING_DIRECTORY: ${{ inputs.working-directory }}

dist/index.js

@@ -23,6 +23,7 @@ const getSha = (): string =>
 
 export const getOptions = (): Promise<Options> => {
   const token = core.getInput('github_token', { required: true })
+  const workingDirectory = core.getInput('working_directory', { required: true })
   const changedFiles = core.getInput('target_files', { required: false }).split(' ')
   const targetFiles = filterSupportedFiles(changedFiles)
   const focus = formatFocusOption(targetFiles)
@@ -31,6 +32,7 @@ export const getOptions = (): Promise<Options> => {
   const pr = context.payload.pull_request
   const options = {
     token,
+    workingDirectory,
     owner: context.repo.owner,
     repo: context.repo.repo,
     issueNumber: pr?.number,

dist/index.js.map

@@ -15,6 +15,7 @@ const baseOptions: Options = {
   focus: `"^test/runDepcruise/sample/__mocks__/test/fixtures/cjs/root_one.js|^test/runDepcruise/sample/__mocks__/test/fixtures/cjs/root_two.js"`,
   depcruiseConfigFilePath: `test/runDepcruise/.dependency-cruiser.js`,
   cruiseScript: 'yarn run -s depcruise',
+  workingDirectory: 'test/runDepcruise',
 }
 
 describe('validateOptions', () => {

src/options.ts

@@ -16,6 +16,7 @@ const optionsSchema = object({
   focus: string().required(),
   depcruiseConfigFilePath: string().required(),
   cruiseScript: string().required(),
+  workingDirectory: string().required(),
 })
 
 export type Options = InferType<typeof optionsSchema>

src/options/validateOptions.test.ts

@@ -8,12 +8,13 @@ describe('reportBody', () => {
       owner: 'octocat',
       repo: 'hello-world',
       issueNumber: 1,
+      workingDirectory: 'src',
       sha: '8ef39983ce21a9c80821addbeb63bfe4d4068f9a',
       mermaidText: 'flowchart LR\n\nA ---> B',
       cmdText:
         'yarn -s depcruise --output-type mermaid --config .dependency-cruiser.js dist/index.js src/options.ts',
     }
-    const expected = `<!-- This comment was generated by dependency-cruiser-report-action. id: ab9d1a5ad3256cbba8c22a27e3c4ef3dabb0f0289ea1f3505ac4537afb1e92bf -->
+    const expected = `<!-- This comment was generated by dependency-cruiser-report-action. id: 793d8403dad1436f27f87c9ec99a41239c663150857545f16267c67caf0731f1 -->
 # dependency-cruiser report
 
 visualize dependenices of changed files.
@@ -28,6 +29,8 @@ Report generated by <a href="https://github.com/MH4GF/dependency-cruiser-report-
 
 ---
 
+working directory: \`src\`
+
 <details>
 <summary>execute command</summary>
 
@@ -45,11 +48,12 @@ yarn -s depcruise --output-type mermaid --config .dependency-cruiser.js dist/ind
       owner: 'octocat',
       repo: 'hello-world',
       issueNumber: 1,
+      workingDirectory: 'src',
       sha: '8ef39983ce21a9c80821addbeb63bfe4d4068f9a',
       mermaidText: 'flowchart LR\n\n\n\n',
       cmdText: 'yarn -s depcruise --output-type mermaid --config .dependency-cruiser.js docs',
     }
-    const expected = `<!-- This comment was generated by dependency-cruiser-report-action. id: ab9d1a5ad3256cbba8c22a27e3c4ef3dabb0f0289ea1f3505ac4537afb1e92bf -->
+    const expected = `<!-- This comment was generated by dependency-cruiser-report-action. id: 793d8403dad1436f27f87c9ec99a41239c663150857545f16267c67caf0731f1 -->
 # dependency-cruiser report
 
 visualize dependenices of changed files.
@@ -60,6 +64,8 @@ Report generated by <a href="https://github.com/MH4GF/dependency-cruiser-report-
 
 ---
 
+working directory: \`src\`
+
 <details>
 <summary>execute command</summary>
 

src/options/validateOptions.ts

@@ -7,6 +7,7 @@ type Params = {
   sha: string
   cmdText: string
   mermaidText: string
+  workingDirectory: string
 }
 
 const NO_OUTPUT_TEXT = 'flowchart LR\n\n\n\n'
@@ -24,7 +25,12 @@ ${text}
 export const reportBody = (params: Params) => {
   const url = 'https://github.com/MH4GF/dependency-cruiser-report-action'
 
-  return `${uniqueTag({ owner: params.owner, repo: params.repo, issueNumber: params.issueNumber })}
+  return `${uniqueTag({
+    owner: params.owner,
+    repo: params.repo,
+    issueNumber: params.issueNumber,
+    workingDirectory: params.workingDirectory,
+  })}
 # dependency-cruiser report
 
 visualize dependenices of changed files.
@@ -35,6 +41,8 @@ Report generated by <a href="${url}">dependency-cruiser report action</a> ${para
 
 ---
 
+working directory: \`${params.workingDirectory}\`
+
 <details>
 <summary>execute command</summary>
 

src/report/body/reportBody.test.ts

@@ -4,15 +4,26 @@ import { uniqueTag } from './uniqueTag'
 
 describe('uniqueTag', () => {
   it('should return tag with hashed id describing the workflow generated', () => {
-    const context = { owner: 'octocat', repo: 'hello-world', issueNumber: 1 }
-    const hashedId = 'ab9d1a5ad3256cbba8c22a27e3c4ef3dabb0f0289ea1f3505ac4537afb1e92bf'
+    const context = {
+      owner: 'octocat',
+      repo: 'hello-world',
+      issueNumber: 1,
+      workingDirectory: 'src',
+    }
+    const hashedId = '793d8403dad1436f27f87c9ec99a41239c663150857545f16267c67caf0731f1'
     const tag = `<!-- This comment was generated by dependency-cruiser-report-action. id: ${hashedId} -->`
     expect(uniqueTag(context)).toBe(tag)
   })
 
   it('should work with extra key/value of passed object', () => {
-    const context = { owner: 'octocat', repo: 'hello-world', issueNumber: 1, extra: 'foo' }
-    const hashedId = 'ab9d1a5ad3256cbba8c22a27e3c4ef3dabb0f0289ea1f3505ac4537afb1e92bf'
+    const context = {
+      owner: 'octocat',
+      repo: 'hello-world',
+      issueNumber: 1,
+      workingDirectory: 'src',
+      extra: 'foo',
+    }
+    const hashedId = '793d8403dad1436f27f87c9ec99a41239c663150857545f16267c67caf0731f1'
     const tag = `<!-- This comment was generated by dependency-cruiser-report-action. id: ${hashedId} -->`
     expect(uniqueTag(context)).toBe(tag)
   })

src/report/body/reportBody.ts

@@ -4,6 +4,7 @@ type Context = {
   owner: string
   repo: string
   issueNumber: number
+  workingDirectory: string
 }
 
 const hashedContext = (context: Context) => {
@@ -12,6 +13,7 @@ const hashedContext = (context: Context) => {
     owner: context.owner,
     repo: context.repo,
     issueNumber: context.issueNumber,
+    workingDirectory: context.workingDirectory,
   }
   hash.update(JSON.stringify(json))
   return hash.digest('hex')