Development¶
Testing¶
To run the tests, run the following command:
or use the make
command:
To run the tests with verbose output, run the following command:
To run a specific test suite, run the following command:
To run a specific test, run the following command:
Running Hide locally¶
To run Hide locally, run the following command:
or use the make
command:
This will start a local server at http://127.0.0.1:8080/
.
Release¶
To release a new version of Hide, follow these steps:
-
Create a new release using the GitHub UI or the command line. For example, to create a new release with the command line, run the following command:
Replace
X.Y.Z
with the version number of the new release following the semantic versioning convention.For additional options and for UI instructions, refer to the GitHub documentation.
-
Update the version in the hide brew formula:
- Copy the URL of the new release (tar.gz file) from the GitHub UI or the command line.
-
Get the SHA256 checksum of the new release (tar.gz file) using the command line:
-
Update the
url
and thesha256
fields in thehide-brew.rb
file to the new release URL and checksum.
Documentation¶
The documentation is built using MkDocs. To build the documentation, install MkDocs
and then run the following command:
The documentation will be built in the site
directory.
To serve the documentation locally, run the following command:
This will start a local server at http://127.0.0.1:8000/
.