Add rendergraph to releases
#1558
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
csasarak
approved these changes
Jun 27, 2025
tools/rendergraph/README.md
Outdated
Comment on lines
8
to
13
| # Installation from source | ||
|
|
||
| 0. Install `rust`: https://www.rust-lang.org/tools/install | ||
| 1. Clone this repo locally | ||
| 2. Run `cargo install --path rendergraph` from the parent directory. | ||
| 3. Use as `fossa analyze -o | rendergraph` (you can also `cat output.json | rendergraph`- any stdin works) |
Contributor
There was a problem hiding this comment.
[nit] Recommend moving this down to the bottom of the readme. A customer who wants to use this can just download the binary, so the docs about how to use it are way more important than how to build it IMO.
tools/rendergraph/README.md
Outdated
| A list of things I've thought of to add. Have an idea? Add it to this list via PR! | ||
|
|
||
| - [ ] Account for graph pruning (use source units to do this) | ||
| - [ ] Support graphviz output |
Contributor
There was a problem hiding this comment.
IMO, this really ought to be a part of Ficus. Being able to just instruct the CLI to do this is a better user-experience than "please download this bin from GH."
This PR is totally fine, I'm just saying we should have that as future work item in this list IMO.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Overview
Cortez and I are working with a customer that would benefit from having our internal
rendergraphtool being public; this PR adds it to the FOSSA CLI repository and releases.rendergraphitself is sort of a "best effort" tool so it doesn't have tests; I don't think it's worth adding to docs as we would expect users to basically use this when we suggest it for troubleshooting.Acceptance criteria
rendergraphis available in FOSSA CLI releases.Testing plan
Sadly, just manual testing
Risks
Yet more random stuff plugged into FOSSA CLI releases 🙃
Metrics
None
References
None
Checklist
docs/.docs/README.msand gave consideration to how discoverable or not my documentation is.Changelog.md. If this PR did not mark a release, I added my changes into an## Unreleasedsection at the top..fossa.ymlorfossa-deps.{json.yml}, I updateddocs/references/files/*.schema.jsonAND I have updated example files used byfossa initcommand. 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).docs/references/subcommands/<subcommand>.md.