Generate attribution report

[dylmye]

Overview

This PR adds the option for users to generate and retrieve an attribution report after they have run analyze.

The inspiration and use case for this feature is from personal needs. I have an app that uses FOSSA, and I want to include the attribution report in the app bundle as part of the release process. Automating the report generation as part of the release process would save time and ensure it's correct for each release version.

I reached out to Kevin after he reached out to us users earlier this month and he pointed me to this repo. Thank you for everything you all do!! Fossa is a really fantastic and beneficial part of the FOSS ecosystem. <3

There's some limitations and questions I have regarding this PR:

• Only supports the attribution report - no SBOM
• No timeout argument provided - should there be a sensible default?
• Is report generation appropriate to be in the scope of your action? Or just something I should fork instead? I'm aware of the message on your README but thought there would be some benefit to users in adding this.
• Is the format of the input okay? I thought it would be tidier than making two (like generate-report boolean and report-format input)
• There's no action-side validation of the report format, the aim of this was to reduce maintenance burden

The only other change I made was typing the listeners object passed to the exec function.

Checklist

• If I changed code, I ran yarn build and committed resulting changes.
• I added an example exercising this PRs functionality to .github/workflows/test.yml or explained why it doesn't make sense to do so.

[jssblck]

Hey @dylmye, thanks for the contribution!

Is report generation appropriate to be in the scope of your action? Or just something I should fork instead? I'm aware of the message on your README but thought there would be some benefit to users in adding this.

We're discussing this and will keep you updated.

[jssblck]

Validated that the dist is correctly generated from the content:

; gh pr checkout 53
remote: Enumerating objects: 23, done.
remote: Counting objects: 100% (23/23), done.
remote: Compressing objects: 100% (9/9), done.
remote: Total 23 (delta 12), reused 23 (delta 12), pack-reused 0 (from 0)
Unpacking objects: 100% (23/23), 11.77 KiB | 325.00 KiB/s, done.
From github.com:fossas/fossa-action
 * [new ref]         refs/pull/53/head -> dylmye/main
Switched to branch 'dylmye/main'

; sha256 dist/index.js
SHA256 (dist/index.js) = 7246e326dee613d6e3bdffc2440cdd0ff978821f207fc13b6c111ed9ea4cbd4f

; yarn run build
yarn run v1.22.22
$ ncc build src/index.ts -o dist --source-map --license LICENSE --minify
ncc: Version 0.38.1
ncc: Compiling file index.js into CJS
ncc: Using [email protected] (local user-provided)
  10kB  dist/LICENSE
  40kB  dist/sourcemap-register.js
 531kB  dist/index.js
1536kB  dist/index.js.map
1536kB  dist/index.js.map
2117kB  [1705ms] - ncc 0.38.1
✨  Done in 1.80s.

; sha256 dist/index.js
SHA256 (dist/index.js) = 7246e326dee613d6e3bdffc2440cdd0ff978821f207fc13b6c111ed9ea4cbd4f

Change lgtm, thanks @dylmye for adding this!

[dylmye]

Thank you!! I don't have write access so can't merge

[jssblck]

Thank you!! I don't have write access so can't merge

Oh, right. I'll take care of this. Thanks!