Skip to content

Commit 13b91b0

Browse files
committed
Doc updates.
- Fill in HISTORY.rst for 0.7.0.dev0 updates. - Mention code of conduct on CONTRIBUTING.rst page. - Improvements to developing.rst and corresponding ``Makefile`` changes (closes #105).
1 parent 4c71299 commit 13b91b0

4 files changed

Lines changed: 43 additions & 4 deletions

File tree

CONTRIBUTING.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,10 @@
22
Contributing
33
============
44

5+
Please note that this project is released with a `Contributor Code of Conduct
6+
<https://planemo.readthedocs.org/en/latest/conduct.html>`__. By participating
7+
in this project you agree to abide by its terms.
8+
59
Contributions are welcome, and they are greatly appreciated! Every
610
little bit helps, and credit will always be given.
711

HISTORY.rst

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,27 @@ History
99
0.7.0.dev0
1010
---------------------
1111

12+
* Implement `shed_create` command to create Tool Shed repositories from
13+
``.shed.yml`` files (thanks to Eric Rasche). `Pull Request 101`_
14+
* Allow automatic creation of missing repositories during ``shed_upload``
15+
with the new ``--force_repository_creation`` flag (thanks to Eric Rasche).
16+
`Pull Request 102`_
17+
* Allow specifying files to exclude in ``.shed.yml`` when creating tar files
18+
for ``shed_upload`` (thanks to Björn Grüning). `Pull Request 99`_
19+
* Resolve symbolic links when building Tool Shed tar files with
20+
``shed_upload`` (thanks to Dave Bouvier). `Pull Request 104`_
21+
* Add a `Contributor Code of Conduct
22+
<https://planemo.readthedocs.org/en/latest/conduct.html>`__.
23+
`Pull Request 113`_
24+
* Omit ``tool_test_output.json `` from Tool Shed tar file created with
25+
``shed_upload`` (thanks to Dave Bouvier). `Pull Request 111`_
26+
* Update required version of bioblend_ to ``0.5.3``. Fixed `Issue 88`_.
27+
* Initial work on implementing tests cases for Tool Shed functionality.
28+
182fe57_
29+
* Download Galaxy from the new, official Github repository. 7c69bf6_
30+
* Update travis_test to install stable planemo from PyPI. 39fedd2_
31+
* Enable caching on ``--install_galaxy`` by default (disable with
32+
``--no_cache_galaxy``). d755fe7_
1233

1334
---------------------
1435
0.6.0 (2015-03-16)
@@ -141,6 +162,17 @@ History
141162
tools - and more experimental features involving Docker and Homebrew. 7d07782_
142163

143164
.. github_links
165+
.. _Pull Request 111: https://github.com/galaxyproject/planemo/pull/111
166+
.. _Pull Request 99: https://github.com/galaxyproject/planemo/pull/99
167+
.. _Pull Request 101: https://github.com/galaxyproject/planemo/pull/101
168+
.. _Pull Request 102: https://github.com/galaxyproject/planemo/pull/102
169+
.. _Issue 88: https://github.com/galaxyproject/planemo/issues/88
170+
.. _182fe57: https://github.com/galaxyproject/planemo/commit/182fe57
171+
.. _Pull Request 104: https://github.com/galaxyproject/planemo/pull/104
172+
.. _7c69bf6: https://github.com/galaxyproject/planemo/commit/7c69bf6
173+
.. _39fedd2: https://github.com/galaxyproject/planemo/commit/39fedd2
174+
.. _d755fe7: https://github.com/galaxyproject/planemo/commit/d755fe7
175+
.. _Pull Request 113: https://github.com/galaxyproject/planemo/pull/113
144176
.. _Pull Request 98: https://github.com/galaxyproject/planemo/pull/98
145177
.. _0bd4ff0: https://github.com/galaxyproject/planemo/commit/0bd4ff0
146178
.. _Pull Request 99: https://github.com/galaxyproject/planemo/pull/99
@@ -192,3 +224,5 @@ History
192224
.. _a2c13e4: https://github.com/galaxyproject/planemo/commit/a2c13e46259e3be35de1ecaae858ba818bb94734
193225
.. _36f7cb11: https://github.com/galaxyproject/planemo/commit/36f7cb114f77731f90860d513a930e10ce5c1ba5
194226
.. _b9232e55: https://github.com/galaxyproject/planemo/commit/b9232e55e713abbd1d9ce8b0b34cbec6c701dc17
227+
228+
.. _bioblend: https://github.com/galaxyproject/bioblend/

Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ release-test: dist
7878
if [ -f .venv/bin/activate ]; then . .venv/bin/activate; fi; twine upload -r test dist/*
7979
open https://testpypi.python.org/pypi/planemo || xdg-open https://testpypi.python.org/pypi/planemo
8080

81-
release:
81+
release: release-test
8282
@while [ -z "$$CONTINUE" ]; do \
8383
read -r -p "Have you executed release-test and reviewed results? [y/N]: " CONTINUE; \
8484
done ; \

docs/developing.rst

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
Developing
33
==========
44

5-
This section contains documentation for developers of planemo.
5+
This section contains documentation for the maintainers of planemo.
66

77
Release Checklist
88
-----------------
@@ -37,9 +37,10 @@ are fine.
3737
* Update release date and description in ``HISTORY.rst``.
3838
* ``make docs`` and review changelog.
3939
* ``git add HISTORY.rst planemo/__init__.py; git commit -m "Version <version>"``
40-
* ``make release-test``
41-
* Review `Test PyPI <https://testpypi.python.org/pypi/planemo>`_ for errors (install with ``pip install -i https://testpypi.python.org/pypi planemo``).
4240
* ``make release``
41+
* Review `Test PyPI site <https://testpypi.python.org/pypi/planemo>`_
42+
for errors.
43+
* Test intall ``pip install -i https://testpypi.python.org/pypi planemo``.
4344
* ``git tag <release>``
4445
* Update version info in ``planemo/__init__.py`` (n+1.dev0) and create new entry in HISTORY.rst.
4546
* ``git add HISTORY.rst planemo/__init__.py; git commit -m "Start work on new version"``

0 commit comments

Comments
 (0)