Skip to content

Release version 0.4.2 #105

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.

Sign up for GitHub

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

Merged
merged 2 commits into from
Aug 9, 2017
Merged

Release version 0.4.2 #105

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0c48554
Release version 0.4.2
ntninja Aug 7, 2017
65d88f5
Small amendments to the build documentation
ntninja Aug 7, 2017
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
23 changes: 14 additions & 9 deletions docs/releasing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,22 +1,24 @@
Since releasing new versions is currently a somewhat complicated task, the current procedure
(02.06.2017) will be outlined in this document.
(07.08.2017) will be outlined in this document.

All of this has only ever been tested on Debian 9 (Linux).
All of this has only been tested on Debian 9 & Fedora 26 (Linux).

# Prerequirements

## Building and updating the project

### Python 3 with `setuptools` and `wheel` support

APT line: `sudo apt install python3-setuptools python3-wheel`
APT line: `sudo apt install python3-setuptools python3-wheel`
DNF line: `sudo dnf install python3-setuptools python3-wheel`

### PanDoc

PanDoc is used to on-the-fly convert the `README.md` to reStructuredText when running `./setup.py`.
This way we can keep all the project documentation in one (nice) format.

APT line: `sudo apt install pandoc`
APT line: `sudo apt install pandoc`
DNF line: `sudo dnf install pandoc`

## Building the documentation

Expand All @@ -25,7 +27,8 @@ APT line: `sudo apt install pandoc`
Sphinx is the standard documentation framework for Python. Recommonmark is an extension that allows
Sphinx to process Markdown documentation as if it where reStructuredText.

APT line: `sudo apt install python3-sphinx python3-recommonmark`
APT line: `sudo apt install python3-sphinx python3-recommonmark`
DNF line: `sudo dnf install python3-sphinx python3-recommonmark`

## Hosting Documentation

Expand All @@ -44,22 +47,24 @@ and then publishes the resulting hash as the node's primary hash. This is curren
new versions of the documentation.

You can download it at:
https://ipfs.io/ipns/QmZ86ow1byeyhNRJEatWxGPJKcnQKG7s51MtbHdxxUddTH/Software/Python/ipfs-file-publish
[https://ipfs.io/ipns/QmZ86ow1byeyhNRJEatWxGPJKcnQKG7s51MtbHdxxUddTH/Software/Python/ipfs-file-publish](https://ipfs.io/ipns/QmZ86ow1byeyhNRJEatWxGPJKcnQKG7s51MtbHdxxUddTH/Software/Python/ipfs-file-publish)


# Steps when releasing a new version

## Update the source code

1. Make a GIT commit incrementing the version number in `ipfsapi/version.py` (`git commit ipfsapi/version.py`)
2. Tag the GIT commit with the version number (`git tag 0.4.X`)
1. Make a GIT commit incrementing the version number in `ipfsapi/version.py`:
`git commit -m "Release version 0.4.X" ipfsapi/version.py`)
2. Tag the GIT commit with the version number using an annotated and signed tag:
`git tag --sign -m "Release version 0.4.X" 0.4.X`
3. Push the new version

## Upload the new version to PyPI

Run: `./setup.py sdist bdist_wheel upload`

**You must have `pandoc` installed or the description PyPI will be replaced with nothing!**
**You must have `pandoc` installed or the description PyPI will be replaced with nothingness!**

## Re-generate the documentation

Expand Down
2 changes: 1 addition & 1 deletion ipfsapi/version.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,4 @@
# `0.4.1` and so on. When IPFS `0.5.0` is released, the first client version
# to support it will also be released as `0.5.0`.

__version__ = "0.4.1"
__version__ = "0.4.2"