Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add info on minor release #139

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion requirements/docs.txt
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,7 @@ pydocstyle
pygments
restructuredtext_lint
rstcheck
sphinx==1.7.*
sphinx==3.4.3
docutils < 0.17
sphinx_rtd_theme==0.5.1
readthedocs-sphinx-search==0.1.0rc3
2 changes: 2 additions & 0 deletions src/pyDataverse/docs/source/user/basic-usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -297,6 +297,8 @@ always leads to a major version change:
>>> resp = api.publish_dataset(ds_pid, release_type="major")
Dataset doi:10.5072/FK2/EO7BNB published

Note that the version release needs to be ``major`` if any files were added or modified.
A ``minor`` release will work for metadata changes, but it will return an error if there are changes in the dataset content.

.. _user_basic-usage_download-data:

Expand Down