... | ... | @@ -60,8 +60,6 @@ twine upload miniff.<>.<>.tar.gz |
|
|
|
|
|
- Two additional stages, namely package and deploy are added in the CI to test the single command installation of miniff (pip install miniff) before you go ahead and do the actual upload of a new version of the miniff on PyPI. In the package stage, the source distribution is generated, then, the single command installation is tested on this source distribution package in the deploy stage.
|
|
|
|
|
|
- Upon each push to the master, the CI pipeline tests miniff against the minimal and the latest version of the dependencies in a parallel build matrix.
|
|
|
|
|
|
## Software citation
|
|
|
|
|
|
Unlike GitHub, the process of archiving a software in a GitLab repository on Zenodo and obtaining a DOI is manual. There seems to be no integration plugin for GitLab yet. Each new version of the software will therefore have to be uploaded manually on Zenodo. The first version of miniff has already been archived on Zenodo and a DOI has been obtained.
|
... | ... | @@ -81,17 +79,17 @@ A new DOI will be generated for each new version of the software that will be ar |
|
|
|
|
|
The dependencies of miniff are captured in the following files.
|
|
|
|
|
|
* requirements.txt and an environment.yml file in the root directory. These files are provided to facilitate replicating miniff development environment for pip and conda users respectively.
|
|
|
* **setup.py** - Bare minimum packages needed to install and run miniff
|
|
|
|
|
|
* docs/requirements.txt - Dependencies for building documentation
|
|
|
* **pyproject.toml** captures the build requirements
|
|
|
|
|
|
* setup.py - Bare minimum packages needed to install and run miniff
|
|
|
* **requirements.txt** and **environment.yml** files in the root directory - These files are provided to facilitate replicating miniff development environment for pip and conda users respectively who wish to work from source. In addition to the core dependencies, these files contain development only dependencies such as nosetest, sphinx, etc.
|
|
|
|
|
|
* pyproject.toml - Build requirements
|
|
|
* **docs/requirements.txt** - Dependencies for building the documentation. This file is utilized by Read the Docs to build the documentation as explained in the section [Read the Docs configuration](#Read-the-Docs-configuration)
|
|
|
|
|
|
The minimum working versions of the dependencies are listed in the above files.
|
|
|
|
|
|
**In the event when the dependencies needs to be updated in the case of add/removal or version update, the change should reflect in all the above files.**
|
|
|
**In the event when the dependencies needs to be updated in the case of addition/removal of any dependency or version update, the change should reflect in all the above files.**
|
|
|
|
|
|
|
|
|
## Software versioning and Release management
|
... | ... | |