-
Notifications
You must be signed in to change notification settings - Fork 62
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
036156d
commit 0d395b9
Showing
1 changed file
with
27 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,27 @@ | ||
# Deployment Instructions | ||
|
||
## Source Code | ||
The matrixprofile library consists a multi-stage TravisCI build. The steps to create a release are as follows: | ||
|
||
1. Update the version.py | ||
2. Update the docs/Releases.md | ||
3. Push the commit with the release to master. | ||
|
||
``` | ||
git commit version.py docs/Releases.md -m "release vX.X.X" | ||
git push origin master | ||
``` | ||
|
||
4. Now we create a git tag that triggers a TravisCI build. | ||
|
||
``` | ||
git tag -a 'vX.X.X' -m 'release vX.X.X' | ||
git push --tags | ||
``` | ||
|
||
## API Documentation | ||
The API documentation is hosted on Github pages. A bash script exists to "deploy" the code. | ||
|
||
``` | ||
bash docs/deploy_docs.sh | ||
``` |