From 4e6b202620fe15ef124ea842b522ce544bd764d9 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Ricau Date: Thu, 9 May 2024 17:22:10 -0700 Subject: [PATCH] update release instructions --- .gitignore | 5 ++++- docs/releasing.md | 4 +++- 2 files changed, 7 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index db65023b97..a8105a0a53 100644 --- a/.gitignore +++ b/.gitignore @@ -39,4 +39,7 @@ out site # Generated dokka -docs/api \ No newline at end of file +docs/api + +# Python virtual env +venv \ No newline at end of file diff --git a/docs/releasing.md b/docs/releasing.md index 7d4cb15032..b7dc5617bf 100644 --- a/docs/releasing.md +++ b/docs/releasing.md @@ -89,6 +89,8 @@ gh alias set --shell closeMilestone "echo '{\"state\": \"closed\"}' | gh api --m ### Install or update the doc generation dependencies ```bash +python3 -m venv venv +source venv/bin/activate pip3 install --requirement docs/requirements.txt ``` @@ -164,7 +166,7 @@ echo '{ "description": "" }' | gh createMilestone && \ mkdocs gh-deploy -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)' +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)' ``` * 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.