Skip to content

Commit

Permalink
add deployment instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
tylerwmarrs committed Jan 12, 2021
1 parent 036156d commit 0d395b9
Showing 1 changed file with 27 additions and 0 deletions.
27 changes: 27 additions & 0 deletions DEPLOYMENT.md
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
```

0 comments on commit 0d395b9

Please sign in to comment.