turbot/github_sherlock

Control: README should be added in each public repository

Description

Adding a README provides important information to help inform the community about the project.

Usage

Run the control in your terminal:

powerpipe control run github_sherlock.control.public_repo_readme_added

Snapshot and share results via Turbot Pipes:

powerpipe login
powerpipe control run github_sherlock.control.public_repo_readme_added --share

Steampipe Tables

SQL

select
r.url as resource,
case
when p.readme is not null then 'ok'
else 'alarm'
end as status,
r.name_with_owner || case when (p.readme is not null) then ' has a ' else ' has no ' end || 'README.' as reason,
r.name_with_owner
from
github_my_repository as r
left join github_community_profile as p on r.name_with_owner = p.repository_full_name
where
visibility = 'PUBLIC' and r.is_fork = false

Tags