Merge pull request #961 from openwpm/release-prep

feat: update Firefox version and all OpenWPM dependencies

.pre-commit-config.yaml

@@ -4,7 +4,7 @@ repos:
     hooks:
     -   id: isort
   - repo: https://github.com/psf/black
-    rev: 21.6b0
+    rev: 21.11b1
     hooks:
       - id: black
         language_version: python3
@@ -15,5 +15,10 @@ repos:
         additional_dependencies: [pytest, types-tabulate, types-PyYAML, types-redis]
         # We may need to add more and more dependencies here, as pre-commit
         # runs in an environment without our dependencies
+  - repo: https://github.com/alessandrojcm/commitlint-pre-commit-hook
+    rev: v6.0.0
+    hooks:
+      - id: commitlint
+        stages: [commit-msg]
 
 

CHANGELOG.md

@@ -1,5 +1,9 @@
 # Changelog
 
+## v0.18.0 - 2021-12-07
+
+Updates OpenWPM to Firefox 95
+
 ## v0.17.0 - 2021-07-23
 
 Updates OpenWPM to Firefox 90.0.2

CONTRIBUTING.md

@@ -1,6 +1,5 @@
 # Contributing <!-- omit in toc -->
 
-
 - [Setting up a dev enviroment](#setting-up-a-dev-enviroment)
 - [General Hints and Guidelines](#general-hints-and-guidelines)
   - [Avoid failing tests for PRs caused by formatting/linting issues](#avoid-failing-tests-for-prs-caused-by-formattinglinting-issues)
@@ -12,6 +11,7 @@
   - [Updating schema docs](#updating-schema-docs)
 
 ## Setting up a dev enviroment
+
 Dev dependencies are installed by using the main `environment.yaml` (which
 is used by `./install.sh` script).
 
@@ -52,13 +52,15 @@ continuing the crawl). We recommend using
 This utility allows manual debugging of the extension instrumentation with or
 without Selenium enabled, as well as makes it easy to launch a Selenium
 instance (without any instrumentation)
-* `./scripts/build-extension.sh`
-* `python -m test.manual_test` builds the current extension directory
+
+- `./scripts/build-extension.sh`
+- `python -m test.manual_test` builds the current extension directory
   and launches a Firefox instance with it.
-* `python -m test.manual_test --selenium` launches a Firefox Selenium instance
+- `python -m test.manual_test --selenium` launches a Firefox Selenium instance
   after automatically rebuilding `openwpm.xpi`. The script then
   drops into an `ipython` shell where the webdriver instance is available
   through variable `driver`.
+
 * `python -m test.manual_test --selenium --no_extension` launches a Firefox Selenium
   instance with no instrumentation. The script then
   drops into an `ipython` shell where the webdriver instance is available
@@ -73,8 +75,10 @@ This means that `environment.yaml` should not be edited directly.
 Instead, place new requirements in `scripts/environment-unpinned.yaml` or `scripts/environment-unpinned-dev.yaml`
 and then run repin:
 
-    $ cd scripts
-    $ ./repin.sh
+```bash
+    cd scripts
+    ./repin.sh
+```
 
 To update the version of firefox, the TAG variable must be updated in the `./scripts/install-firefox.sh`
 script. This script contains further information about finding the right TAG.
@@ -84,13 +88,14 @@ script. This script contains further information about finding the right TAG.
 OpenWPM's tests are build on [pytest](https://docs.pytest.org/en/latest/). Execute `py.test -vv`
 in the test directory to run all tests:
 
-    $ conda activate openwpm
-    $ py.test -vv
+```bash
+    conda activate openwpm
+    py.test -vv
+```
 
 See the [pytest docs](https://docs.pytest.org/en/latest/) for more information on selecting
 specific tests and various pytest options.
 
-
 ### Updating schema docs
 
 In the rare instance that you need to create schema docs