-
Notifications
You must be signed in to change notification settings - Fork 175
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
updating versioning.md file with new dev-release flow
- Loading branch information
Showing
2 changed files
with
3 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters