Skip to content

Commit

Permalink
Remove markdown formatting in reStructuredText formatted README (#1103)
Browse files Browse the repository at this point in the history
A recent change to the README has code blocks in markdown format.
Since our README is actually reStructuredText format, this causes
syntax errors.

It's even bigger of a problem when an attempt to publish the package
with the README serving as the PyPI description. The syntax errors
prevents package publishing.

Fixes #1102

Signed-off-by: Eric Brown <[email protected]>
  • Loading branch information
ericwb authored Jan 23, 2024
1 parent ff7ed4b commit 3f86e84
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,9 @@ Container Images
Bandit is available as a container image, built within the bandit repository
using GitHub Actions. The image is available on ghcr.io:

```bash
docker pull ghcr.io/pycqa/bandit/bandit
```
.. code-block:: console
docker pull ghcr.io/pycqa/bandit/bandit
The image is built for the following architectures:

Expand All @@ -103,17 +103,17 @@ The image is built for the following architectures:

To pull a specific architecture, use the following format:

```bash
docker pull --platform=<architecture> ghcr.io/pycqa/bandit/bandit:latest
```
.. code-block:: console
docker pull --platform=<architecture> ghcr.io/pycqa/bandit/bandit:latest
Every image is signed with sigstore cosign and it is possible to verify the
source of origin using the following cosign command:

```bash
cosign verify ghcr.io/pycqa/bandit/bandit:py39-amd64 \
--certificate-identity https://github.com/pycqa/bandit/.github/workflows/build-publish-image.yml@refs/tags/<version> \
--certificate-oidc-issuer https://token.actions.githubusercontent.com
```
.. code-block:: console
cosign verify ghcr.io/pycqa/bandit/bandit:py39-amd64 \
--certificate-identity https://github.com/pycqa/bandit/.github/workflows/build-publish-image.yml@refs/tags/<version> \
--certificate-oidc-issuer https://token.actions.githubusercontent.com
Where `<version>` is the release version of Bandit.

0 comments on commit 3f86e84

Please sign in to comment.