The goal of this GitHub Optimization Project is to provide tangible progress and recommendations for BC Government that will nurture and grow a healthy, compliant, and vibrant open-source development community.
This repository includes the following artifacts developed to understand the repositories in bcgov and BCDevOps GitHub organizations:
grafana-github-plugin: a forked repository of the official grafanagithub-datasourcescripts-go: a set of golang scripts to collect repository data from GitHub APIscripts: a set of javascript scripts to collect repository data from GitHub APInotebook:Jupyternotebook to merge repository data files into the master csv file
-
grafana-github-plugin: For information on setting up the grafana dashboard, please refer to its README. -
scripts-go: To run the go scripts, there are two variables expected,GITHUB_TOKENandGITHUB_ORG. The token requires a personal access token from your github account, and the github organization can be set to an existing organization, e.g. bcgov. To set the tokens, run:export GITHUB_TOKEN=<your PAT>export GITHUB_ORG=<your organization>
-
scripts: before running the scripts, follow the .env.example file to add a personal access token. -
notebook: runjupyter notebookfrom the notebook directory to launch the notebooks.
This project was setup using the tool asdf, and required tool version can be setup using it if you have asdf installed.
If not, the required tools and versions are located in .tool-versions and can be installed.
This project is in the experimental stage.
Please see our public project backlog for more information about the roadmap and goals.
If you have difficulties or problems, please open an issue and we will be happy to get back to you.
If you would like to contribute to the guide, please see our CONTRIBUTING guideleines.
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.