Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Reachability] Scan summary and better docs #1379

Merged
merged 10 commits into from
Feb 14, 2024
Merged

Conversation

meghfossa
Copy link
Contributor

@meghfossa meghfossa commented Feb 13, 2024

Overview

This PR,

  • Adds scan summary for reachability analysis
  • Adds better docs for reachability, and moves reachability docs in better location

Acceptance criteria

  • Scan summary is displayed for reachability

Testing plan

git checkout feat/better-docs && make install-dev

git clone https://github.com/fossas/reachability-with-maven-example.git
cd reachability-with-maven-example

# (required) perform maven build
# if jar artifact is not present reachability will not be performed
mvn package

# Analyze with fossa-dev
fossa-dev analyze -p reachability-example-better-docs -r example-revision --fossa-api-key <MY-FOSSA-KEY>
  • You should see the scan summary in stdout.
  • You should see OrgId does not support reachability message, if your org does not support reachability

Risks

N/A

Metrics

N/A

References

https://fossa.atlassian.net/browse/ANE-1416

  • I added tests for this PR's change (or explained in the PR description why tests don't make sense).
  • If this PR introduced a user-visible change, I added documentation into docs/.
  • If this PR added docs, I added links as appropriate to the user manual's ToC in docs/README.ms and gave consideration to how discoverable or not my documentation is.
  • If this change is externally visible, I updated Changelog.md. If this PR did not mark a release, I added my changes into an # Unreleased section at the top.
  • If I made changes to .fossa.yml or fossa-deps.{json.yml}, I updated docs/references/files/*.schema.json AND I have updated example files used by fossa init command. You may also need to update these if you have added/removed new dependency type (e.g. pip) or analysis target type (e.g. poetry).
  • If I made changes to a subcommand's options, I updated docs/references/subcommands/<subcommand>.md.

@meghfossa meghfossa changed the title better ux and docs for reachability [Reachability] Scan summary and better docs Feb 13, 2024
@@ -70,3 +72,9 @@ data ParsedJar = ParsedJar
deriving (Eq, Ord, Show, Generic)

instance ToJSON ParsedJar

reachabilityRawJson :: Text
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To avoid circular imports

@meghfossa meghfossa marked this pull request as ready for review February 13, 2024 03:16
@meghfossa meghfossa requested a review from a team as a code owner February 13, 2024 03:16
@meghfossa meghfossa requested review from csasarak and jssblck and removed request for csasarak February 13, 2024 03:16
docs/README.md Outdated Show resolved Hide resolved
src/App/Fossa/Analyze/ScanSummary.hs Show resolved Hide resolved
src/App/Fossa/Analyze/Upload.hs Outdated Show resolved Hide resolved
src/App/Fossa/Reachability/Upload.hs Outdated Show resolved Hide resolved
@meghfossa meghfossa merged commit 66aa638 into master Feb 14, 2024
16 checks passed
@meghfossa meghfossa deleted the feat/better-docs branch February 14, 2024 23:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants