Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions Makefile

This file was deleted.

11 changes: 1 addition & 10 deletions admin/create_secrets_files.py
Original file line number Diff line number Diff line change
@@ -1,15 +1,6 @@
"""Create licenses and target databases for the tests to run against.

Usage:

$ export VWS_EMAIL_ADDRESS=...
$ export VWS_PASSWORD=...
# For ``make update-secrets`` to work, this has to be ``./ci_secrets``, or
# you have to copy the secrets there later.
$ export NEW_SECRETS_DIR=...
$ export EXISTING_SECRETS_FILE=/existing/file/with/inactive/db/creds
# You may have to run this a few times, but it is idempotent.
$ python admin/create_secrets_files.py
See the instructions in the contributing guide in the documentation.
"""

import datetime
Expand Down
3 changes: 2 additions & 1 deletion docs/source/ci-setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,8 @@ Add the encrypted secrets files to the repository:

.. code-block:: console

$ PASSPHRASE_FOR_VUFORIA_SECRETS="<CHOSEN_SECRET>" make update-secrets
$ tar cvf secrets.tar ci_secrets/
$ gpg --yes --batch --passphrase="${PASSPHRASE_FOR_VUFORIA_SECRETS}" --symmetric --cipher-algo AES256 secrets.tar
$ git add secrets.tar.gpg
$ git commit -m "Update secret archive"
$ git push
25 changes: 21 additions & 4 deletions docs/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -91,8 +91,25 @@ To create an inactive project, delete the license key associated with a database
Targets sometimes get stuck at the "Processing" stage meaning that they cannot be deleted.
When this happens, create a new target database to use for testing.

To create databases without using the browser, use :file:`admin/create_secrets_files.py`.
See instructions in that file.
To create databases without using the browser, use :file:`admin/create_secrets_files.py`:

.. code-block:: bash

$ export VWS_EMAIL_ADDRESS=...
$ export VWS_PASSWORD=...
$ export NEW_SECRETS_DIR=...
$ export EXISTING_SECRETS_FILE=/existing/file/with/inactive/db/creds
# You may have to run this a few times, but it is idempotent.
$ python admin/create_secrets_files.py
# After creating the secrets, update the encrypted archive:
$ tar cvf secrets.tar "${NEW_SECRETS_DIR}"
$ gpg \
--yes \
--batch \
--passphrase="${PASSPHRASE_FOR_VUFORIA_SECRETS}" \
--symmetric \
--cipher-algo AES256 \
secrets.tar

.. _Vuforia License Manager: https://developer.vuforia.com/vui/develop/licenses
.. _Vuforia Target Manager: https://developer.vuforia.com/vui/develop/databases
Expand Down Expand Up @@ -120,8 +137,8 @@ Run the following commands to build and view documentation locally:

.. code-block:: console

$ make docs
$ make open-docs
$ uv run --extra=dev sphinx-build -M html docs/source docs/build -W
$ python -c 'import os, webbrowser; webbrowser.open("file://" + os.path.abspath("docs/build/html/index.html"))'

Continuous Integration
----------------------
Expand Down