... | ... | @@ -60,19 +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.
|
|
|
|
|
|
## 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.
|
|
|
|
|
|
When a new version of miniff is ready for release, follow the below steps to archive it on Zenodo.
|
|
|
- Log in to Zenodo and go to the miniff archive home page (add link).
|
|
|
- Select the option upload new version.
|
|
|
- Download the code for the latest tag from miniff repository and upload on the above page.
|
|
|
- Update the metadata if necessary: title, description, version, authors (authors list can be found in AUTHORS.md of miniff repository). The metadata can be edited and updated after the DOI is generated so optional fields can be left empty for now.
|
|
|
- Click save and publish.
|
|
|
|
|
|
A new DOI will be generated for each new version of the software that will be archived on Zenodo. However, all the versions of the software and their corresponding DOIs will be visible on the project home page.
|
|
|
|
|
|
|
|
|
## Dependency management
|
|
|
|
... | ... | @@ -93,6 +80,20 @@ The dependencies of miniff are captured in the following files. Each of these fi |
|
|
**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 and be consistent.**
|
|
|
|
|
|
|
|
|
## 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.
|
|
|
|
|
|
When a new version of miniff is ready for release, follow the below steps to archive it on Zenodo.
|
|
|
- Log in to Zenodo and go to the miniff archive home page (add link).
|
|
|
- Select the option upload new version.
|
|
|
- Download the code for the latest tag from miniff repository and upload on the above page.
|
|
|
- Update the metadata if necessary: title, description, version, authors (authors list can be found in AUTHORS.md of miniff repository). The metadata can be edited and updated after the DOI is generated so optional fields can be left empty for now.
|
|
|
- Click save and publish.
|
|
|
|
|
|
A new DOI will be generated for each new version of the software that will be archived on Zenodo. However, all the versions of the software and their corresponding DOIs will be visible on the project home page.
|
|
|
|
|
|
|
|
|
## Software versioning and Release management
|
|
|
|
|
|
### Branching model
|
... | ... | @@ -127,10 +128,8 @@ git checkout -b <feature-abc> master |
|
|
* Bump up the minor version if you are adding new feature, functionality that is backwards compatible.
|
|
|
* bump up the major version if you are making ground breaking backwards incompatible changes.
|
|
|
|
|
|
|
|
|
* Bump up the version number in setup.py
|
|
|
|
|
|
|
|
|
* Ideally, make a merge request towards master when your changes are complete, i.e., all the required changes for a particular new major, minor or patch version that you intend to create are present in your feature branch. This ensure that master doesn't have a half baked new functionality/feature/bugfix at any point in time.
|
|
|
|
|
|
|
... | ... | |