Skip to content

Commit

Permalink
Update docs and release_notes.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
dormant-user committed May 13, 2024
1 parent 480dfcf commit 7eff38e
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 18 deletions.
5 changes: 2 additions & 3 deletions docs/README.html
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ <h3>Add <code class="docutils literal notranslate"><span class="pre">none-shall-
<li><p>Search for <code class="docutils literal notranslate"><span class="pre">none-shall-pass</span></code> from the <a class="reference external" href="https://github.com/marketplace/actions/none-shall-pass">Marketplace</a> tab on the right.</p></li>
<li><p>Copy and paste the yaml into your workflow.</p></li>
</ul>
<p><img alt="marketplace" src="https://raw.githubusercontent.com/thevickypedia/none-shall-pass/main/images/marketplace.png" /></p>
<p><strong>[OR]</strong></p>
<p>Copy &amp; paste the following workflow definition into your project <code class="docutils literal notranslate"><span class="pre">.github/workflows/none-shall-pass.yml</span></code></p>
<div class="highlight-yaml notranslate"><div class="highlight"><pre><span></span><span class="nt">name</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">Validate hyperlinks in markdown files</span>

Expand All @@ -112,8 +112,7 @@ <h3>Add <code class="docutils literal notranslate"><span class="pre">none-shall-
<span class="w"> </span><span class="nt">none-shall-pass</span><span class="p">:</span>
<span class="w"> </span><span class="nt">runs-on</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ubuntu-latest</span>
<span class="w"> </span><span class="nt">steps</span><span class="p">:</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">thevickypedia/[email protected]</span><span class="w"> </span><span class="c1"># Powered by Python</span>
<span class="w"> </span><span class="c1"># - uses: thevickypedia/none-shall-pass@v4 # Powered by Rust</span>
<span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="nt">uses</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">thevickypedia/none-shall-pass@v3</span>
</pre></div>
</div>
<ul class="simple">
Expand Down
6 changes: 2 additions & 4 deletions docs/_sources/README.md.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ within markdown files in your repository and wiki pages.
- Search for `none-shall-pass` from the [Marketplace][marketplace] tab on the right.
- Copy and paste the yaml into your workflow.

![marketplace][screenshot]
**[OR]**

Copy & paste the following workflow definition into your project `.github/workflows/none-shall-pass.yml`

Expand All @@ -30,8 +30,7 @@ jobs:
none-shall-pass:
runs-on: ubuntu-latest
steps:
- uses: thevickypedia/[email protected] # Powered by Python
# - uses: thevickypedia/none-shall-pass@v4 # Powered by Rust
- uses: thevickypedia/none-shall-pass@v3
```

- Commit your changes to trigger the workflow or run the workflow manually.
Expand Down Expand Up @@ -80,7 +79,6 @@ bash pre_commit.sh
Licensed under the [MIT License][license]

[marketplace]: https://github.com/marketplace/actions/none-shall-pass
[screenshot]: https://raw.githubusercontent.com/thevickypedia/none-shall-pass/main/images/marketplace.png
[license]: https://github.com/thevickypedia/none-shall-pass/blob/main/LICENSE
[release-notes]: https://github.com/thevickypedia/none-shall-pass/blob/main/release_notes.rst
[docs]: https://thevickypedia.github.io/none-shall-pass/
Expand Down
2 changes: 1 addition & 1 deletion docs/searchindex.js

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

11 changes: 1 addition & 10 deletions release_notes.rst
Original file line number Diff line number Diff line change
@@ -1,21 +1,12 @@
Release Notes
=============

v4 (02/14/2024)
---------------
- Onboard command line interface creation kit

v3 (11/05/2023)
v3 (05/13/2024)
---------------
- Onboard none-shall-pass-rustic
- Remove Dockerfile and python dependencies
- Run scans via executable directly to reduce runtime
- Improves speed and accuracy
- Alpha stage tests

v3.0a-prerelease-1699121888 (11/04/2023)
----------------------------------------
- Bump checkout to v3

v2.0-prerelease-1698262793 (10/25/2023)
---------------------------------------
Expand Down

0 comments on commit 7eff38e

Please sign in to comment.