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

Update manual dependencies docs #1030

Merged
merged 13 commits into from
Aug 26, 2022
Merged

Conversation

spatten
Copy link
Contributor

@spatten spatten commented Aug 25, 2022

Overview

closes #1027

  • fix some discrepancies between the documentation for manual-deps and the schema
  • fix a trailing comma in the schema for fossa-deps.yml
  • Add a lint-check for the schemas
  • Fix a miss-spelling of "fontawesome"
  • Change spectrometer => fossa-cli in a few spots

Acceptance criteria

  • the fossa-deps.yml schema should be valid
  • invalid schemas should fail the lint-check
  • we should use fossa-cli instead of spectrometer in our example URLs where possible
  • The fetchers in the manual-dependencies documentation should match those in the schema

Testing plan

I tested that the linter caught an invalid schema by reverting the fix to the schema and checking that the linter failed.

Everything else is a documentation fix.

Risks

None

References

Checklist

  • 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 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. 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).

@spatten spatten marked this pull request as ready for review August 26, 2022 00:01
@spatten spatten requested a review from a team as a code owner August 26, 2022 00:01
@spatten spatten requested a review from zlav August 26, 2022 00:01
Copy link
Member

@zlav zlav left a comment

Choose a reason for hiding this comment

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

LGTM!

Changelog.md Outdated
@@ -1,5 +1,9 @@
# FOSSA CLI Changelog

## Unreleased

- Fix a bug in fossa-deps.schema.json. It is now valid JSON.
Copy link
Member

Choose a reason for hiding this comment

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

You should add the PR link to the end of the line.

| [haskell-language-server][hls] ("HLS") | LSP server for haskell projects |
| [hlint][hlint] | A linting + hints tool for haskell code. It provides really useful suggestions. `hlint` is bundled with HLS |
| [fourmolu][fourmolu] | A haskell source code formatter. `fourmolu` is bundled with HLS |
| name | description |
Copy link
Member

Choose a reason for hiding this comment

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

🙌

@spatten spatten enabled auto-merge (squash) August 26, 2022 00:10
@spatten spatten merged commit f36c590 into master Aug 26, 2022
@spatten spatten deleted the update-manual-dependencies-docs branch August 26, 2022 00:34
@thernstig
Copy link

@spatten did this miss to fix bullet point 2) in #1027 ?

@spatten
Copy link
Contributor Author

spatten commented Aug 26, 2022

@spatten did this miss to fix bullet point 2) in #1027 ?

I think that there were two discrepancies: swift was not mentioned in the docs, and bower was not included in the schema. I updated both of these in the PR.

I think that fixes the problem. I've just looked again, and I think the two lists match. Did I miss something?

@thernstig
Copy link

@spatten you are correct, it was fixed properly, sorry for the noise.

@spatten
Copy link
Contributor Author

spatten commented Aug 29, 2022

@spatten you are correct, it was fixed properly, sorry for the noise.

No problem at all! Thanks for flagging this in the Issue :)

This pull request was closed.
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.

Docs: manual-dependencies.md incorrect
3 participants