#!/usr/bin/env bash # vim:ts=4:sts=4:sw=4:et # # Author: Hari Sekhon # Date: 2020-02-07 15:01:31 +0000 (Fri, 07 Feb 2020) # # https://github.com/HariSekhon/DevOps-Bash-tools # # License: see accompanying Hari Sekhon LICENSE file # # If you're using my code you're welcome to connect with me on LinkedIn and optionally send me feedback to help steer this or other code I publish # # https://www.linkedin.com/in/HariSekhon # set -euo pipefail [ -n "${DEBUG:-}" ] && set -x srcdir="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" # shellcheck disable=SC1090 . "$srcdir/lib/github.sh" top_N="${TOP_N:-100}" # shellcheck disable=SC2034,SC2154 usage_description=" Script to generate a Markdown page containing the headers and CI/CD status badges of the Top N rated by stars GitHub repos Examples: Without arguments queries for all non-fork repos for your \$GITHUB_ORGANIZATION or \$GITHUB_USER and iterates up to $top_N of them to generate the page ./github_generate_status_page.sh With arguments will query those repo's README.md at the top level - if omitting the owner prefix will prepend \$GITHUB_ORGANIZATION/ or \$GITHUB_USER/ GITHUB_USER=HariSekhon ./github_generate_status_page.sh DevOps-Python-tools DevOps-Perl-tools SomeOtherCoolGuy/his-repo GITHUB_ORGANIZATION=my-org ./github_generate_status_page.sh HariSekhon/DevOps-Python-tools some-org-repo Supported Environment Variables: EXCLUDE_REPOS - an ERE regex or repos to exclude TOP_N - an integer of the top N number of repos to include, ranked by star count " # used by usage() in lib/utils.sh # shellcheck disable=SC2034 usage_args="[ ...]" help_usage "$@" trap 'echo ERROR >&2' exit is_int "$top_N" || die "Invalid TOP_N '$top_N' specified, must be an integer" repolist="$*" # this leads to confusion as it generates some randomly unexpected output by querying a github user who happens to have the same name as your local user eg. hari, so force explicit now #USER="${GITHUB_USER:-${USERNAME:-${USER}}}" GITHUB_USER="${GITHUB_USER:-$(get_github_user || :)}" if is_blank "${GITHUB_USER:-}" || [ "$GITHUB_USER" = null ]; then die "\$GITHUB_USER not set and could not infer user from token!" fi OWNER="${GITHUB_ORGANIZATION:-$GITHUB_USER}" if is_blank "${OWNER:-}" || [ "$OWNER" = null ]; then die "\$GITHUB_ORGANIZATION / \$GITHUB_USER not set and could not infer user from token!" fi prefix="users" if [ -n "${GITHUB_ORGANIZATION:-}" ]; then prefix="orgs" fi get_repos(){ page=1 while true; do echo "fetching GitHub repos - page $page" >&2 if ! output="$("$srcdir/github_api.sh" "/$prefix/$OWNER/repos?page=$page&per_page=100")"; then echo "ERROR" >&2 exit 1 fi # use authenticated requests if you are hitting the API rate limit - this is automatically done above now if USER/PASSWORD GITHUB_USER/GITHUB_PASSWORD/GITHUB_TOKEN environment variables are detected # eg. CURL_OPTS="-u harisekhon:$GITHUB_TOKEN" ... if [ -z "$(jq '.[]' <<< "$output")" ]; then break elif jq -r '.message' <<< "$output" >&2 2>/dev/null; then exit 1 fi jq -r '.[] | select(.fork | not) | select(.private | not) | [.full_name, .stargazers_count, .forks] | @tsv' <<< "$output" ((page+=1)) done } original_sources=0 if [ -z "$repolist" ]; then repolist="$(get_repos | if [ -n "${EXCLUDE_REPOS:-}" ]; then grep -Ev "$EXCLUDE_REPOS" || : else cat fi | sort -k2nr -k3nr | awk '{print $1}' | head -n "$top_N")" original_sources=1 fi num_repos="$(wc -w <<< "$repolist")" num_repos="${num_repos// /}" #echo "$repolist" >&2 # make portable between linux and mac head(){ if [ "$(uname -s)" = Darwin ]; then # from brew's coreutils package (installed by 'make') ghead "$@" else command head "$@" fi } tempfile="$(mktemp)" trap 'echo ERROR >&2; rm -f $tempfile' exit { actual_repos=0 total_stars=0 total_forks=0 echo "getting followers" >&2 followers="$("$srcdir/github_api.sh" "/$prefix/$OWNER" | jq -r .followers)" echo "---" >&2 for repo in $repolist; do if ! [[ "$repo" =~ / ]]; then repo="$OWNER/$repo" fi echo "fetching GitHub repo info for '$repo'" >&2 repo_json="$("$srcdir/github_api.sh" "/repos/$repo")" description="$(jq -r .description <<< "$repo_json")" stars="$(jq -r .stargazers_count <<< "$repo_json")" forks="$(jq -r .forks <<< "$repo_json")" #watchers="$(jq -r .watchers <<< "$repo_json")" ((total_stars += stars)) ((total_forks += forks)) #((total_watchers += watchers)) echo "fetching GitHub README.md for '$repo'" >&2 echo "---" echo "---" >&2 { #perl -e '$/ = undef; my $content=; $content =~ s///gs; print $content' | curl -sS "https://raw.githubusercontent.com/$repo/master/README.md" | perl -pe '$/ = undef; s///gs' | sed -n '1,/^[^\[[:space:]<=-]/ p' | head -n -1 | #perl -ne 'print unless /=============/;' | grep -v "===========" | sed '1 s/^[^#]/# &/' } | { read -r title printf '%s\n' "$title" echo printf '%s\n' "Link: [$repo](https://github.com/$repo)" echo printf '%s\n' "$description" cat } # works for Link which is a limited format, but couldn't expect to safely inject a description line pulled from the GitHub API because all sorts of characters could be contained which break this, so instead doing this via the brace piping trick above # \\ escapes the newlines to allow them inside the sed for literal replacement since \n doesn't work #sed "2 s|^|\\ #\\ #Link: [$repo](https://github.com/$repo) #|" echo ((actual_repos+=1)) done } > "$tempfile" if [ "$num_repos" != "$actual_repos" ]; then echo "ERROR: differing number of target github repos ($num_repos) vs actual repos ($actual_repos)" exit 1 fi hosted_build_regex='\[.+(' hosted_build_regex+='travis-ci.+\.svg' hosted_build_regex+='|github\.com/.+/workflows/.+/badge\.svg' hosted_build_regex+='|dev\.azure\.com/.+/_apis/build/status' hosted_build_regex+='|app\.codeship\.com/projects/.+/status' hosted_build_regex+='|appveyor\.com/api/projects/status' hosted_build_regex+='|circleci\.com/.+\.svg' hosted_build_regex+='|cloud\.drone\.io/api/badges/.+/status.svg' hosted_build_regex+='|g\.codefresh\.io/api/badges/pipeline/' hosted_build_regex+='|api\.shippable\.com/projects/.+/badge' hosted_build_regex+='|app\.wercker\.com/status/' hosted_build_regex+='|img\.shields\.io/.*/buildspec.yml' hosted_build_regex+='|img\.shields\.io/.*/cloudbuild.yaml' hosted_build_regex+='|img\.shields\.io/.+/pipeline' hosted_build_regex+='|img\.shields\.io/.+/build/' hosted_build_regex+='|img\.shields\.io/buildkite/' hosted_build_regex+='|img\.shields\.io/cirrus/' hosted_build_regex+='|img\.shields\.io/docker/build/' hosted_build_regex+='|img\.shields\.io/docker/cloud/build/' hosted_build_regex+='|img\.shields\.io/travis/' hosted_build_regex+='|img.shields.io/badge/Shippable' hosted_build_regex+='|img.shields.io/badge/TravisCI' hosted_build_regex+='|img\.shields\.io/shippable/' hosted_build_regex+='|img\.shields\.io/wercker/ci/' hosted_build_regex+='|app\.buddy\.works/.*/pipelines/pipeline/.*/badge.svg' hosted_build_regex+='|img\.shields\.io/badge/Buddy' hosted_build_regex+='|\.semaphoreci\.com/badges/' hosted_build_regex+=')' # to check for any badges missed, just go #grep -Ev "$hosted_build_regex" README.md self_hosted_build_regex='\[\!\[[^]]+\]\(.*\)\]\(.*/blob/master/(' self_hosted_build_regex+='Jenkinsfile' self_hosted_build_regex+='|.concourse.yml' self_hosted_build_regex+='|.gocd.yml' self_hosted_build_regex+=')\)' self_hosted_build_regex+='|img\.shields\.io/badge/TeamCity' if [ -n "${DEBUG:-}" ]; then echo echo "Hosted Builds:" echo grep -E "$hosted_build_regex" "$tempfile" >&2 || : echo echo "Self-Hosted Builds:" echo grep -E "$self_hosted_build_regex" "$tempfile" >&2 || : fi num_hosted_builds="$(grep -Ec "$hosted_build_regex" "$tempfile" || :)" num_self_hosted_builds="$(grep -Ec "$self_hosted_build_regex" "$tempfile" || :)" num_builds=$((num_hosted_builds + num_self_hosted_builds)) lines_of_code_counts="$( grep -Ei 'img.shields.io/badge/lines%20of%20code-[[:digit:]]+(\.[[:digit:]]+)?k' "$tempfile" | sed 's|.*img.shields.io/badge/lines%20of%20code-||; s/[[:alpha:]].*$//'| tr '\n' '+' | sed 's/+$//' || : )" # on Mac piping to | bc -l works, but on Linux breaks, but <<< works lines_of_code="$(bc -l <<< "$lines_of_code_counts" || echo "unknown")" cat <