util functions for software life cycle enforcement on github
Project description
PDS utility function for github
Enforces the PDS engineering node software lifecycle:
- publish snapshot releases for python (
python-snapshot-release) or maven (maven-snaphot-release) projects - create requirements reports (
requirement-report) - ping a repository, ie creates an empty commit & push e.g. to trigger github action (
git-ping) - create build summaries from .gitmodule file (
summaries)
These routines are called from github actions.
They are orchestrated around the pdsen-corral repository
Prerequisites
libxml2 is used to do publish a snapshot release of a maven project (maven-snaphot-release). It needs to be deployed as follow:
Macos
brew install libxml2
cd ./venv/lib/python3.7/site-packages/ # chose the site package of the used python
ln -s /usr/local/Cellar/libxml2/2.9.10/lib/python3.7/site-packages/* .
Ubuntu
sudo apt-get update && sudo apt-get install libxml2-dev libxslt-dev python-dev
pip install lxml
deploy and run
Deploy:
pip install pds-gihub-util
Some environment variable need to be set (they are defined by default in github action but need to be set manually otherwise)
export GITHUB_WORKSPACE=<where the repository which we want to publish a snapshot is cloned>
export GITHUB_REPOSITORY=<full name of the repository which we want to publish for example NASA-PDS-Incubator/pds-app-registry>
Get command arguments:
maven-snapshot-release --help
python-snapshot-release --help
requirement-report --help
git-ping --help
summaries --help
Development
git clone ...
cd pds-github-util
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
Update the code
Test the code:
export GITHUB_TOKEN=<personal access token for github>
python setup.py test
Create package and publish it:
Set the version in setup.py
Tag the code
git tag <version>
git push origin --tags
The package will be published to pypi automatically though github action.
Manually publish the package
Create the package:
python setup.py sdist
Publish it as a github release.
Publish on pypi (you need a pypi account):
pip install twine
twine upload dist/*
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for pds_github_util-0.11.8-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5ea22ef9f26cb4541037f9a431cf915a9cb73bb6a92ef0f738899db41348c6ff |
|
| MD5 | aec6fd51de7636965dc4460d680aa748 |
|
| BLAKE2b-256 | 615615eacec516fdca43612a5a6d9bbe75710f26cb04aa0bf3603e03705e507c |
