project-root inference in your code-health workflow

Open
#415 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Bug
Clarity
Needs clarification
Activity status
Active
Tech stack
python
Domain
tooling

Research direction

Review the comment and current invocation in code-health.yml, then gather the wrong project-root details or a run where the sanity check fired. The requested outcome is for pyscn to resolve the full project correctly and produce both JSON and HTML from one analyze invocation, but the implementation location and scope are not identified.

Written by the indexing model from the issue text.

Description

Hi! I'm the author of pyscn. I came across this repo and noticed you're running it in your weekly code-health workflow. Thanks for using it.

I also read the comment in code-health.yml about pyscn inferring the wrong project root and silently resolving only part of the imports, which inflates the score. That's a real problem on my side and I'd like to fix it rather than have you work around it. If you remember what the wrong root looked like (or a run where the sanity check fired), I'd appreciate the details. Same for having to run analyze twice to get both JSON and HTML; that should be a single invocation.

Separately, there's a GitHub App that runs the same analysis on a schedule and posts the reports for you, in case it saves some upkeep:
https://github.com/apps/polyscan-app

If anything else comes up, feel free to let me know.

Dominant language
Python
Stars
266
Forks
63
Avg merge
1d 20h
Merged PRs (30d)
19

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from DOI-USGS/dataretrieval-python

All issues in DOI-USGS/dataretrieval-python

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.