[SYNC-3518] Add documentation for installing python packages

Closes: #5281
mozilla · Oct 5, 2023 · b7cb31d · b7cb31d
1 parent 86bbfb0
commit b7cb31d
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/docs/howtos/releases.md b/docs/howtos/releases.md
@@ -119,7 +119,8 @@ diff --git a/CHANGELOG.md b/CHANGELOG.md
 
 
 ### [Release management] Creating a new release via scripts:
-1. Run the `automation/prepare-release.py` script.  This should:
+1. Run `pip3 install -r automation/requirements.txt` to install the required Python packages.
+2. Run the `automation/prepare-release.py` script.  This should:
   * Create a new branch named `release-vXXX`
   * Create a PR against that branch that updates `version.txt` like this:
 
@@ -134,7 +135,7 @@ index 8cd923873..6482018e0 100644
 ```
   * Create a PR on `main` that starts a new CHANGELOG header.
 
-2. Tag the release with `automation/tag-release.py [major-version-number]`
+3. Tag the release with `automation/tag-release.py [major-version-number]`
 
 
 

diff --git a/docs/howtos/smoke-testing-app-services.md b/docs/howtos/smoke-testing-app-services.md
@@ -3,6 +3,10 @@
 This is a great way of finding integration bugs with `application-services`.
 The testing can be done manually using substitution scripts, but we also have scripts that will do the smoke-testing for you.
 
+## Dependencies
+
+Run `pip3 install -r automation/requirements.txt` to install the required Python packages.
+
 ## Android Components
 
 The `automation/smoke-test-android-components.py` script will clone (or use a local version) of