Skip to content

Commit

Permalink
updating versioning.md file with new dev-release flow
Browse files Browse the repository at this point in the history
  • Loading branch information
jgostick committed Jul 3, 2020
1 parent 763fa92 commit 7ce750f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 3 deletions.
4 changes: 2 additions & 2 deletions VERSIONING.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
## Release Management and Versioning

`OpenPNM` uses [Semantic Versioning](http://semver.org) (i.e. X.Y.Z) to label releases. All major and minor versions (X.Y.z) are available on [PyPI](https://pypi.python.org/pypi), but bugfix releases (x.y.Z) are not generally pushed unless the bug is important. Bugfix releases are available via download of the source code from Github.
`OpenPNM` uses [Semantic Versioning](http://semver.org) (i.e. X.Y.Z) to label releases. As of verion 2.3.2, all versions of OpenPNM are available on [PyPI](https://pypi.python.org/pypi). Prior to this, only major and minor version were pushed.

`OpenPNM` uses the [Github Flow](https://guides.github.com/introduction/flow/) system of Git branching, except instead of merging PRs into *master*, they are merged into a branch called *dev*. Any code added to *dev* is done via Pull Requests (PRs). When new PRs are merged into the *dev* branch, they are *not* given a new version number. Once enough new features have been added, the *dev* branch is merged into the *master* branch, and the minor release number (x.Y.z) will be incremented. An exception to this rule are bugfixes which may be found on *master*. In these cases a PR can be merged into *master* and the version number will be incremented (x.y.Z) to indicate the fix.
All development occurs on `dev` via feature branches and the pull request functionality of Github. A new release is defined each time the `dev` branch is merged into the `release` branch. Several automations are setup so that upon each release, the code is automatically deployed to PyPi and Conda, and a release announcement is created on Github containing a summary of all the changes. This `dev` and `release` workflow replaces the previous approach based on gitflow.

`OpenPNM` depends on several other packages widely known as the [Scipy Stack](https://www.scipy.org/stackspec.html). It is our policy to always support the latest version of all these packages and their dependencies.
2 changes: 1 addition & 1 deletion docs/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Installing OpenPNM

OpenPNM requires the *Scipy Stack* (Numpy, Scipy, Matplotlib, etc), which is most conveniently obtained by installing the `Anaconda Distribution <https://conda.io/docs/user-guide/install/download.html>`_, so first download and install this if you don't have it already.

OpenPNM can be installed from the `Python Package Index https://pypi.org/project/openpnm/`_ using:
OpenPNM can be installed from the `Python Package Index <https://pypi.org/project/openpnm/>`_ using:

.. code-block::
Expand Down

0 comments on commit 7ce750f

Please sign in to comment.