Skip to content

Commit

Permalink
Merge pull request #19 from hoatle/tasks/#18-v0.4.0-release
Browse files Browse the repository at this point in the history
@ #18 | should release v0.4.0
  • Loading branch information
hoatle authored Mar 1, 2019
2 parents e09180f + d17f403 commit 4b8876c
Show file tree
Hide file tree
Showing 4 changed files with 21 additions and 8 deletions.
16 changes: 16 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
Change Log
==========


[0.4.0][] (2019-03-01)
----------------------

- Features:
+ should support sphinx-autobuild #12
+ should support Docker workflow #13

- Improvements:
+ should replace --set-upstream by --set-upstream-to instead #14

Details: https://github.com/teracyhq/sphinx-deployment/milestone/1?closed=1

0.3.1 (2015-08-24)
------------------

Expand Down Expand Up @@ -50,3 +63,6 @@ Change Log
[0.2.0]: https://issues.teracy.org/secure/ReleaseNote.jspa?projectId=10405&version=10004

[0.3.0]: https://issues.teracy.org/secure/ReleaseNote.jspa?projectId=10405&version=10301

[0.4.0]: https://github.com/teracyhq/sphinx-deployment/milestone/1?closed=1

4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,14 +71,14 @@ You need to specify the `<docs_path>` to your sphinx docs directory:

``` bash
$ cd <your_project>
$ wget https://raw.githubusercontent.com/teracyhq/sphinx-deployment/develop/scripts/spxd.sh && chmod +x ./spxd.sh && ./spxd.sh -p <docs_path>
$ wget https://raw.githubusercontent.com/teracyhq/sphinx-deployment/v0.4.0/scripts/spxd.sh && chmod +x ./spxd.sh && ./spxd.sh -p <docs_path>
```

For example:

``` bash
$ cd my_project
$ wget https://raw.githubusercontent.com/teracyhq/sphinx-deployment/develop/scripts/spxd.sh && chmod +x ./spxd.sh && ./spxd.sh -p ./docs
$ wget https://raw.githubusercontent.com/teracyhq/sphinx-deployment/v0.4.0/scripts/spxd.sh && chmod +x ./spxd.sh && ./spxd.sh -p ./docs
```

**2. Manual**
Expand Down
7 changes: 2 additions & 5 deletions release.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,17 +6,14 @@ The documentation is used to release `sphinx-deployment`.
README.md
---------

- Find `https://raw.github.com/teracy-official/sphinx-deployment/develop/scripts/spxd.sh` and
- Find `https://raw.githubusercontent.com/teracyhq/sphinx-deployment/develop/scripts/spxd.sh` and
replace `develop` with the right release version, for example: `v0.1.0`

CHANGELOG.md
------------

- Copy release notes from sphinx-deployment project on issues.teracy.org, for example:
- Mention issues from https://github.com/teracyhq/sphinx-deployment/issues for each release milestone

https://issues.teracy.org/secure/ReleaseNote.jspa?version=10003&styleName=Text&projectId=10405&Create=Create&atl_token=BD5N-YNBS-EHHQ-478Z%7C87dd31199258f9de5ade180582481463461ded32%7Clin

- Note: Only copy the main issues that is worth mentioning and change the format to Markdown instead.

scripts/spxd.sh
---------------
Expand Down
2 changes: 1 addition & 1 deletion scripts/spxd.sh
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@
############################################################################
# Example to install on <your_project/docs>
# $ cd <your_project>
# $ wget https://raw.githubusercontent.com/teracyhq/sphinx-deployment/develop/scripts/spxd.sh && chmod +x ./spxd.sh && ./spxd.sh -p ./docs
# $ wget https://raw.githubusercontent.com/teracyhq/sphinx-deployment/v0.4.0/scripts/spxd.sh && chmod +x ./spxd.sh && ./spxd.sh -p ./docs
#

function command_exists() {
Expand Down

0 comments on commit 4b8876c

Please sign in to comment.