|
|
# git flow
|
|
|
|
|
|
CIGALE development is done using Git and gitflow. Gitflow is both a
|
|
|
[branching model](http://nvie.com/posts/a-successful-git-branching-model/) and
|
|
|
a [git extention](https://github.com/nvie/gitflow) allowing to easily implement
|
|
|
this branching model. You'll find all the information on how to install and use
|
|
|
gitflow on [its Github page](https://github.com/nvie/gitflow).
|
|
|
|
|
|
# Preparing a new release
|
|
|
|
|
|
Here is a quick description on how to prepare a new CIGALE release.
|
|
|
|
|
|
* Start a new gitflow release:
|
|
|
|
|
|
```shell
|
|
|
git flow release start v0.7.0
|
|
|
```
|
|
|
* Update CIGALE version number and make last minute corrections in the
|
|
|
preparation of the release. Commit the changes.
|
|
|
|
|
|
* Finish the release:
|
|
|
|
|
|
```shell
|
|
|
git flow release finish v0.7.0
|
|
|
|
|
|
```
|
|
|
|
|
|
* Giflow will:
|
|
|
|
|
|
- Merge the `develop` branch with the release additions into the `master`
|
|
|
branch. It's a good idea to quickly describe the new release in the
|
|
|
commit message.
|
|
|
|
|
|
- Add a `v0.7.0` tag. You must give a tag message “Version 0.7.0” is enough.
|
|
|
|
|
|
- Merge the change made for the release back in the `develop` branch.
|
|
|
|
|
|
* Prepare a tarball with the new release using the newly created tag:
|
|
|
|
|
|
```shell
|
|
|
git archive --prefix=pcigale/ -o ../pcigale.tar v0.7.0
|
|
|
```
|
|
|
|
|
|
* Rename, compress… the created tarball and put it on CIGALE web page. |