Skip to content

Commit 4e6b202

Browse files
committed
update release instructions
1 parent 6a22757 commit 4e6b202

File tree

2 files changed

+7
-2
lines changed

2 files changed

+7
-2
lines changed

.gitignore

+4-1
Original file line numberDiff line numberDiff line change
@@ -39,4 +39,7 @@ out
3939
site
4040

4141
# Generated dokka
42-
docs/api
42+
docs/api
43+
44+
# Python virtual env
45+
venv

docs/releasing.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,8 @@ gh alias set --shell closeMilestone "echo '{\"state\": \"closed\"}' | gh api --m
8989
### Install or update the doc generation dependencies
9090

9191
```bash
92+
python3 -m venv venv
93+
source venv/bin/activate
9294
pip3 install --requirement docs/requirements.txt
9395
```
9496

@@ -164,7 +166,7 @@ echo '{
164166
"description": ""
165167
}' | gh createMilestone && \
166168
mkdocs gh-deploy
167-
gh release create v{{ leak_canary.next_release }} ./shark-cli/build/distributions/shark-cli-{{ leak_canary.next_release }}.zip --title v{{ leak_canary.next_release }} --notes 'See [Change Log](https://square.github.io/leakcanary/changelog)'
169+
gh release create v{{ leak_canary.next_release }} ./shark/shark-cli/build/distributions/shark-cli-{{ leak_canary.next_release }}.zip --title v{{ leak_canary.next_release }} --notes 'See [Change Log](https://square.github.io/leakcanary/changelog)'
168170
```
169171

170172
* Open the [v{{ leak_canary.next_release }} release](https://github.com/square/leakcanary/releases/tag/v{{ leak_canary.next_release }}) to confirm everything looks good.

0 commit comments

Comments
 (0)