adelorenzo/stable
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #2454 from freqtrade/release_docs

Browse Source 
[minor][docs] Update release-documentation to fit new release style
This commit is contained in:
hroff-1902 2019-10-31 09:02:55 +03:00 committed by GitHub
commit 4fa12ffda0
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 9 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
docs/developer.md
View File

@ -204,14 +204,15 @@ This part of the documentation is aimed at maintainers, and shows how to create
### Create release branch ### Create release branch
``` bash First, pick a commit that's about one week old (to not include latest additions to releases).
# make sure you're in develop branch
git checkout develop
``` bash
# create new branch # create new branch
git checkout -b new_release git checkout -b new_release <commitid>
``` ```
Determine if crucial bugfixes have been made between this commit and the current state, and eventually cherry-pick these.
* Edit `freqtrade/__init__.py` and add the version matching the current date (for example `2019.7` for July 2019). Minor versions can be `2019.7-1` should we need to do a second release that month. * Edit `freqtrade/__init__.py` and add the version matching the current date (for example `2019.7` for July 2019). Minor versions can be `2019.7-1` should we need to do a second release that month.
* Commit this part * Commit this part
* push that branch to the remote and create a PR against the master branch * push that branch to the remote and create a PR against the master branch
@ -219,23 +220,18 @@ git checkout -b new_release
### Create changelog from git commits ### Create changelog from git commits
!!! Note !!! Note
Make sure that both master and develop are up-todate!. Make sure that the master branch is uptodate!
``` bash ``` bash
# Needs to be done before merging / pulling that branch. # Needs to be done before merging / pulling that branch.
git log --oneline --no-decorate --no-merges master..develop git log --oneline --no-decorate --no-merges master..new_release
``` ```
### Create github release / tag ### Create github release / tag
Once the PR against master is merged (best right after merging): Once the PR against master is merged (best right after merging):
* Use the button "Draft a new release" in the Github UI (subsection releases) * Use the button "Draft a new release" in the Github UI (subsection releases).
* Use the version-number specified as tag. * Use the version-number specified as tag.
* Use "master" as reference (this step comes after the above PR is merged). * Use "master" as reference (this step comes after the above PR is merged).
* Use the above changelog as release comment (as codeblock) * Use the above changelog as release comment (as codeblock).
### After-release
* Update version in develop by postfixing that with `-dev` (`2019.6 -> 2019.6-dev`).
* Create a PR against develop to update that branch.