GHCR_BUILD.md

SCANOSS Python GitHub Container Repo

The SCANOSS python package provides a simple, easy to consume library for interacting with SCANOSS APIs/Engine.

Usage

The image can be run from the command line, or from within a pipeline.

For more details, please look in GHCR.md.

Development

Before starting with development of this project, please read our CONTRIBUTING and CODE OF CONDUCT.

Requirements

Docker client needs to be installed locally.

A login to GitHub Packages is also needed, should you wish to publish the image. Details of generating a personal access token can be found here.

Repo Development

More details on Docker build/deployment can be found here.

Build

To build a local image from the Dockerfile please use:

make ghcr_build

To test this image please run:

docker run -it ghcr.io/scanoss/scanoss-py 

For more details execution options, please look in GHCR.md.

Versioning

The version of the package is defined in the scanoss init file. Please update this version before packaging/releasing an update.

To tag the latest build, please run:

make ghcr_tag

Deployment

In order to deploy the image, a user needs to generate a personal access token (PAT) on GitHub. More details here.

Then login using:

export CR_PAT=YOUR_TOKEN
echo $CR_PAT | docker login ghcr.io -u USERNAME --password-stdin

And push the image using:

make ghcr_push

This will deploy the image to GHCR.

The image will then be available to install using:

docker pull ghcr.io/scanoss/scanoss-py:latest

Bugs/Features

To request features or alert about bugs, please do so here.

Changelog

Details of major changes to the library can be found in CHANGELOG.md.