Skip to content

Commit d3e61d7

Browse files
committed
Deployed c142981 to dev with MkDocs 1.6.1 and mike 2.1.3
1 parent 51ddf17 commit d3e61d7

File tree

2 files changed

+10
-11
lines changed

2 files changed

+10
-11
lines changed

dev/CONTRIBUTING/index.html

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -960,7 +960,6 @@ <h3 id="development-prerequisites">Development prerequisites<a class="headerlink
960960
<p>To build Arduino Lint from sources you need the following tools to be available in your local environment:</p>
961961
<ul>
962962
<li><a href="https://golang.org/doc/install">Go</a></li>
963-
<li><a href="https://taskfile.dev/#/installation">Taskfile</a> to help you run the most common tasks from the command line</li>
964963
</ul>
965964
<p>If you want to run integration tests or work on documentation, you will also need:</p>
966965
<ul>
@@ -979,7 +978,7 @@ <h3 id="development-prerequisites">Development prerequisites<a class="headerlink
979978
</ul>
980979
<h3 id="building-the-source-code">Building the source code<a class="headerlink" href="#building-the-source-code" title="Permanent link">&para;</a></h3>
981980
<p>From the project folder root, just run:</p>
982-
<div class="highlight"><pre><span></span><code>task<span class="w"> </span>build
981+
<div class="highlight"><pre><span></span><code>go<span class="w"> </span>tool<span class="w"> </span>github.com/go-task/task/v3/cmd/task<span class="w"> </span>build
983982
</code></pre></div>
984983
<p>The project uses Go modules, so dependencies will be downloaded automatically. At the end of the build, you should find
985984
the <code>arduino-lint</code> executable in the same folder.</p>
@@ -988,11 +987,11 @@ <h3 id="running-the-checks">Running the checks<a class="headerlink" href="#runni
988987
<p>There are several checks and test suites in place to ensure the code works as expected and is written in a way that's
989988
consistent across the whole codebase. To avoid pushing changes that will cause the CI system to fail, you can run the
990989
checks locally by running this command:</p>
991-
<div class="highlight"><pre><span></span><code>task check
990+
<div class="highlight"><pre><span></span><code>go tool github.com/go-task/task/v3/cmd/task check
992991
</code></pre></div>
993992
<h4 id="go-unit-tests">Go unit tests<a class="headerlink" href="#go-unit-tests" title="Permanent link">&para;</a></h4>
994993
<p>To run only the Go unit tests, run:</p>
995-
<div class="highlight"><pre><span></span><code>task go:test
994+
<div class="highlight"><pre><span></span><code>go tool github.com/go-task/task/v3/cmd/task go:test
996995
</code></pre></div>
997996
<p>By default, all tests for all Arduino Lint's Go packages are run. To run unit tests for only one or more specific
998997
packages, you can set the <code>TARGETS</code> environment variable, e.g.:</p>
@@ -1011,23 +1010,23 @@ <h4 id="integration-tests">Integration tests<a class="headerlink" href="#integra
10111010
<code>arduino-lint</code> in a different process and assess the options are correctly understood and the output is what we expect.</p>
10121011
<h5 id="running-tests">Running tests<a class="headerlink" href="#running-tests" title="Permanent link">&para;</a></h5>
10131012
<p>After the software requirements have been installed, you should be able to run the tests with:</p>
1014-
<div class="highlight"><pre><span></span><code>task go:test-integration
1013+
<div class="highlight"><pre><span></span><code>go tool github.com/go-task/task/v3/cmd/task go:test-integration
10151014
</code></pre></div>
10161015
<p>This will automatically install the necessary dependencies, if not already installed, and run the integration tests
10171016
automatically.</p>
10181017
<p>To run specific tests, you must run <code>pytest</code> from the virtual environment created by Poetry.</p>
1019-
<div class="highlight"><pre><span></span><code>task poetry:install &amp;&amp; poetry run pytest tests/test_all.py::test_report_file
1018+
<div class="highlight"><pre><span></span><code>go tool github.com/go-task/task/v3/cmd/task poetry:install &amp;&amp; poetry run pytest tests/test_all.py::test_report_file
10201019
</code></pre></div>
10211020
<p>You can avoid writing the <code>poetry run</code> prefix each time by creating a new shell inside the virtual environment:</p>
1022-
<div class="highlight"><pre><span></span><code>task poetry:install
1021+
<div class="highlight"><pre><span></span><code>go tool github.com/go-task/task/v3/cmd/task poetry:install
10231022
poetry shell
10241023
pytest test_lib.py
10251024
pytest test_lib.py::test_list
10261025
</code></pre></div>
10271026
<h3 id="dependency-license-metadata">Dependency license metadata<a class="headerlink" href="#dependency-license-metadata" title="Permanent link">&para;</a></h3>
10281027
<p>Metadata about the license types of all dependencies is cached in the repository. To update this cache, run the
10291028
following command from the repository root folder:</p>
1030-
<div class="highlight"><pre><span></span><code>task general:cache-dep-licenses
1029+
<div class="highlight"><pre><span></span><code>go tool github.com/go-task/task/v3/cmd/task general:cache-dep-licenses
10311030
</code></pre></div>
10321031
<p>The necessary <strong>Licensed</strong> tool can be installed by following
10331032
<a href="https://github.com/github/licensed#as-an-executable">these instructions</a>.</p>
@@ -1039,7 +1038,7 @@ <h3 id="dependency-license-metadata">Dependency license metadata<a class="header
10391038
<h3 id="automated-corrections">Automated corrections<a class="headerlink" href="#automated-corrections" title="Permanent link">&para;</a></h3>
10401039
<p>Tools are provided to automatically bring the project into compliance with some required checks. Run them all with this
10411040
command:</p>
1042-
<div class="highlight"><pre><span></span><code>task fix
1041+
<div class="highlight"><pre><span></span><code>go tool github.com/go-task/task/v3/cmd/task fix
10431042
</code></pre></div>
10441043
<h3 id="working-on-documentation">Working on documentation<a class="headerlink" href="#working-on-documentation" title="Permanent link">&para;</a></h3>
10451044
<p>Documentation is provided to final users in form of static HTML content generated from a tool called
@@ -1051,7 +1050,7 @@ <h4 id="local-development">Local development<a class="headerlink" href="#local-d
10511050
<p>When working on the documentation, it is useful to be able to see the effect the changes will have on the generated
10521051
documentation website. You can build the documentation website and serve it from your personal computer by running the
10531052
command:</p>
1054-
<div class="highlight"><pre><span></span><code>task website:serve
1053+
<div class="highlight"><pre><span></span><code>go tool github.com/go-task/task/v3/cmd/task website:serve
10551054
</code></pre></div>
10561055
<p>The documentation will build. If you don't see any error, open <code>http://127.0.0.1:8000</code> in your browser to view the local
10571056
copy of the documentation.</p>

dev/search/search_index.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)