ne-ver - Next Version
Ne-ver again the manual hassle to release a next version.
basic usage
Setup an environment with the dependencies once, if you haven't done that yet.
$ python -m venv .venv
$ source .venv/bin/activate
$ pip install ne-ver
$ never -h
usage: never [-h] [--settings | --no-settings] [-f SETTINGS_FILE] [-p PROJECT] {major,minor,patch}
Ne-ver again the manual hassle to release a next version
positional arguments:
{major,minor,patch}
optional arguments:
-h, --help show this help message and exit
--settings, --no-settings
whether to use a settings-file for your configuration, or provide the settings manually
required when using a settings-file for your configuration:
-f SETTINGS_FILE, --settings-file SETTINGS_FILE
-p PROJECT, --project PROJECT
Website: https://github.com/swesterveld/next
GitHub Personal Access Token
A GitHub Personal Access Token (PAT) is required to let never create pull requests for you.
Make sure to generate a PAT in your GitHub Developer Settings,
with at least the scope repo -- for full control of private repositories -- selected.
Add this token to the .env file at the root of your virtualenv.
The .env file should be based on the .env.example file in the examples directory.
Make sure to reload the virtualenv to activate the environment variable(s) defined in the .env file.
settings
Currently, the --no-settings flag doesn't work yet, so you should use a settings file.
The settings file should be JSON-formatted. Its contents should be like:
{
"projects": {
"backend": {
"path": "~/repos/some-repo-clone-of-backend-project",
"branches": {
"release": "release/{version}",
"staging": "develop",
"production": "master"
},
"version_file": "VERSION"
},
"frontend": {
"path": "/home/jdoe/repos/some-repo-clone-of-frontend-project",
"branches": {
"release": "release/{version}",
"staging": "develop",
"production": "master"
},
"version_file": "VERSION",
"package_metadata": "package.json"
}
}
}run
An example, to bump the version from x.y.z to x.y.z+1 for project frontend defined in etc/never.config.json:
never patch --settings -f etc/never.config.json -p frontend
advanced usage: auto merge
When you would like to automagically merge the release branch created by never on GitHub, you should use a deploy key.
To create one, issue:
ssh-keygen -t ed25519 -C "<comment>" -f <filename>
Where the outputfile should be specified by <filename>, and -C "<comment>" is optional, and could contain any
comment that may be useful to help identify the key.
This results in a key-pair, with its private part in <filename> and its public part in <filename>.pub.
In your repository settings (at https://github.com///settings), you should use the contents of
those files to add a deploy key and a secret:
- The public part should be added to your repository as a deploy key with write access.
- The private part should be added as a new repository secret called
NEVER_DEPLOY_KEY.
Besides that, a GitHub Action that will use these this key-pair to automagically merge the release branch is required.
An example could be found at .github/workflows/merge-release.yml and should be copied to .github/workflows/ in your
repository.
development
run in development mode
You could benefit from the option to run setuptools in development mode,
which allows you to modify the source code and have the changes take effect without you having to rebuild and reinstall:
pip install --editable .
build Python package
As a prerequisite for building a Python package you'll need a builder, such as PyPA build.
If you haven't got a builder yet, you can obtain it via pip install build.
To invoke the builder:
python -m build
release to PyPI
python -m twine upload --repository pypi dist/*
dependencies
This project has some dependencies mentioned in the requirements.txt file.
Documentation of these Python packages could be found at:
Other dependencies, from the Python Standard Library, are documented here:
