This page catalogues releases from charm engineering teams. Its content automatically generated every 15 minutes by querying the Github API for information about the Canonical Github org and the Juju Github org.
The page is published at: https://jnsgruk.github.io/releases
The config for the data generation script is lumped in with the Jekyll site config in _config.yml. Updating the list of orgs or repositories there will cause the repos/teams to be included on the site.
Development is easiest using the supplied Dockerfile.
# Clone the repository
git clone https://github.com/jnsgruk/releases
cd releases
# Build the Docker image
docker build -t jnsgruk/releases-dev:latest .
# Run the image, watch for changes
docker run --rm -v $PWD:/src -p 4000:4000 jnsgruk/releases-dev:latest
The site should now be available at http://0.0.0.0:4000/ on your local machine.
_data/repos.json
is automatically rebuilt from a GitHub Action, but you can build it for local
development:
First, create a GitHub token with repo
permissions and copy
it somewhere safe.
Then, make sure you have pip
:
# Install some requirements
sudo apt install python3-pip python3-virtualenv
# Create an enter a virtual environment
python3 -m venv venv
source ./venv/bin/activate
pip install -r requirements.txt
# Set your Github API token as an environment variable
export API_TOKEN=ghp_aBcDeFgHiJkLmNoPqRsTuVwXyZ
# Run the script and redirect the output to the data file.
python3 generate-data.py > _data/repos.json