Skip to content

Commit

Permalink
Merge pull request #891 from dmitriy-serdyuk/release-doc
Browse files Browse the repository at this point in the history
WIP: Add instructions to make a new release
  • Loading branch information
rizar committed Nov 24, 2015
2 parents 1d63fa8 + 455d65f commit 6827a9e
Showing 1 changed file with 58 additions and 0 deletions.
58 changes: 58 additions & 0 deletions docs/development/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -255,6 +255,64 @@ Sending a pull request
See our :doc:`pull request workflow <pull_request>` for a refresher on the
general recipe for sending a pull request to Blocks.

Making a new release
--------------------
.. note:
This section is targeted for Blocks and Fuel administrators.
Create an initial pull request and copy the following piece of markdown code.
This pull request should only change the version number. Then, create a pull
request to Fuel which refers the first PR. Follow the instruction carefully
and check the boxes in process.
```
- **Stage 1**: Make changes in `master`:
- [ ] Freeze other PRs.

After we agreed to initiate the process of releasing a new version,
other PRs shouldn't be merged.
- [ ] Increase the version number counter of Blocks.

Change the version number in `blocks/__init__.py`.
- [ ] Increase the version number counter of Fuel.

Change the version number in `fuel/version.py`.
- **Stage 2**: After two PRs merged to Blocks and Fuel:
- [ ] Create a pull request to merge `master` into `stable`.

Add a link to the initial PR in order not to get lost in the numerous
pull requests.
- [ ] Create a pull request to Fuel.

This will be a corresponding PR to Fuel which merges its `master` into
`stable`. Add a link to the initial PR.
- [ ] Check the Travis CI build log *on both the pull requests merging
`master` into `stable`*.

Read carefully the Travis CI messages, check that it tests the
right version.
- [ ] Check the Theano version.

The `req*.txt` should refer the last development Theano version
which is known not to have bugs.
- [ ] Check the Fuel version in `req*.txt` files.

We should reference the stable version of Fuel. It can be seen
in the Travis CI output.
- [ ] Merge Fuel pull request.
- [ ] Merge this pull request.
- **Stage 3**: After the PRs are merged:
- [ ] Wait the build to pass.
- [ ] Check documentation build at ReadTheDocs.
- [ ] Double check that the version corresponds `__version__`.
- [ ] Create a release of Fuel by going to the
[releases page](https://github.com/mila-udem/fuel/releases) and
clicking "Draft new release".
- [ ] Create a release of Blocks by going to the
[releases page](https://github.com/mila-udem/blocks/releases) and
clicking "Draft new release".

```

.. toctree::
:hidden:

Expand Down

0 comments on commit 6827a9e

Please sign in to comment.