Skip to content

Commit

Permalink
chore: update revision in tox.ini for mkdocs-mermaid-plugin repo
Browse files Browse the repository at this point in the history
Before this commit, there was no revision identifier in the installation command
for the package mkdocs-mermaid-plugin in the 'docs' and the 'docs-serve' tox
testenvs. However, it is good practice to point to a specific commit rather than
the default branch, whose content could change without notice.

This commit adds the revision to the URL pointing to the mkdocs-mermaid-plugin
GitHub repository. In particular, this commit adds 'abf1439' at the end of the
URL of the GitHub repository of the package. The URL to the commit is:

  pugong/mkdocs-mermaid-plugin@abf1439

The change is applied in both 'docs' and 'docs-serve'.
  • Loading branch information
gl3nng0uld committed Jan 21, 2025
1 parent 6e4ba0c commit 87e3c33
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions tox.ini
Original file line number Diff line number Diff line change
Expand Up @@ -280,15 +280,15 @@ skipsdist = True
skip_install = True
deps =
tomte[docs]==0.2.13
commands = pip3 install git+https://github.com/pugong/mkdocs-mermaid-plugin.git#egg=mkdocs-mermaid-plugin
commands = pip3 install git+https://github.com/pugong/mkdocs-mermaid-plugin.git@abf1439#egg=mkdocs-mermaid-plugin
mkdocs build --clean

[testenv:docs-serve]
skipsdist = True
skip_install = True
deps =
tomte[docs]==0.2.13
commands = pip3 install git+https://github.com/pugong/mkdocs-mermaid-plugin.git#egg=mkdocs-mermaid-plugin
commands = pip3 install git+https://github.com/pugong/mkdocs-mermaid-plugin.git@abf1439#egg=mkdocs-mermaid-plugin
mkdocs build --clean
python -c 'print("###### Starting local server. Press Control+C to stop server ######")'
mkdocs serve -a localhost:8080
Expand Down

0 comments on commit 87e3c33

Please sign in to comment.