Skip to content

Commit

Permalink
Tagged Installation Instructions (#840)
Browse files Browse the repository at this point in the history
* added tagged installation instructions

* updated dev docs - new release
  • Loading branch information
srivarra authored Nov 23, 2022
1 parent 1b2183c commit 857f692
Show file tree
Hide file tree
Showing 2 changed files with 10 additions and 5 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,14 +83,18 @@ After the Pixie Pipeline, the user can inspect and fine tune their results with

#### Download the Repo

We recommend using the latest release of `ark`. You can find all the versions available in the [Releases Section](https://github.com/angelolab/ark-analysis/releases).
Open terminal and navigate to where you want the code stored.

Then input the command:
Currently, the latest release is `v0.4.4`.
Then install the latest release with:

```
git clone https://github.com/angelolab/ark-analysis.git
git clone https://github.com/angelolab/ark-analysis.git --depth 1 --branch v0.4.4
```

You may also install previous releases by simply changing the version after the `--branch`.

#### Setting up Docker

There is a complementary [setup video](https://youtu.be/EXMGdi_Izdw).
Expand Down
7 changes: 4 additions & 3 deletions docs/_rtd/development.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,9 +196,10 @@ next_release_vX.Y.Z
1. If, in the release notes draft there are PRs that are not categorized, label them appropriately (usually based on the label of their respective Issue).
2. Make sure that all tests pass for `Ark` on Travis-CI.
3. In the `ark-analysis/start_docker.sh` script, change the `VERSION` variable from `vA.B.C` to `vX.Y.Z`
4. Modify the `.travis.yml` CI configuration script to allow `test_pypi_deploy` to run (comment the line `if: tag IS present`).
5. Request a review and merge the `Ark` branch.
6. Next head to the most recent Drafted Release Notes:
4. In the [`REAMDME.md`](../../README.md#download-the-repo) adjust the `--branch` part of the `git clone` instruction to the new tag `v.X.Y.Z`.
5. Modify the `.travis.yml` CI configuration script to allow `test_pypi_deploy` to run (comment the line `if: tag IS present`).
6. Request a review and merge the `Ark` branch.
7. Next head to the most recent Drafted Release Notes:
1. Double check that the tag is the appropriate version name.
2. Publish the Release.
3. Next the `Ark` will be pushed to PyPI and the Docker Image will be built on Travis CI.
Expand Down

0 comments on commit 857f692

Please sign in to comment.