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

RFC healthcheck #30

Draft
wants to merge 2 commits into
base: main
Choose a base branch
from
Draft

RFC healthcheck #30

wants to merge 2 commits into from

Conversation

ericphanson
Copy link
Member

@ericphanson ericphanson commented Feb 25, 2021

This adds a healthcheck function which is basically an alternate show method:

julia> healthcheck(analyze_from_registry(find_package("DataFrames")))
DataFrames.jl
☑ Has code (16163 lines)
☑ Has docs (3431 lines)
☑ Has tests (16296 lines)
☑ Has license(s)
    MIT (✔ OSI-approved)
☑ Has CI (GitHub Actions)

julia> healthcheck(analyze_from_registry(find_package("CommonMark")))
CommonMark.jl
☑ Has code (3943 lines)
◻ Has docs
☑ Has tests (1215 lines)
☑ Has license(s)
    MIT (✔ OSI-approved)
    BSD-2-Clause (✔ OSI-approved)
    MIT (✔ OSI-approved)
    MIT (✔ OSI-approved)
    CC-BY-SA-4.0 (⨉ not OSI-approved)
☑ Has CI (GitHub Actions)

The idea is it could be used by a package author / maintainer themselves to quickly get a look at the status of their package and/or check off some boxes 🙂. It could also be autocommented in General PRs for package authors to get a sense of the "health" of the package/version they are releasing, and give a nudge towards good practices (and provide more info for passers-by).

Here I used empty boxes instead of Xs to try to be more encouraging.

Opening as draft for feedback; I feel like it could probably use some more tweaking still.

@ericphanson ericphanson marked this pull request as draft February 25, 2021 23:53

healthcheck(p::Package) = healthcheck(stdout, p)

function healthcheck(io::IO, p::Package)
Copy link
Member

@giordano giordano Feb 26, 2021

Choose a reason for hiding this comment

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

If the idea is to have something similar also for RegistryCI, perhaps we want to have multiple methods for different MIMEs (plain text vs markdown)? Or this can be show(::IO, ::MIME"markdown", ::Package)?

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