From 3f86e84b5c0b4aad3995f642c32f554a41c9c6a8 Mon Sep 17 00:00:00 2001 From: Eric Brown Date: Tue, 23 Jan 2024 11:01:27 -0800 Subject: [PATCH] Remove markdown formatting in reStructuredText formatted README (#1103) 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 --- README.rst | 22 +++++++++++----------- 1 file changed, 11 insertions(+), 11 deletions(-) diff --git a/README.rst b/README.rst index a06f90c91..86b972a95 100644 --- a/README.rst +++ b/README.rst @@ -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: @@ -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= ghcr.io/pycqa/bandit/bandit:latest -``` +.. code-block:: console + + docker pull --platform= 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/ \ - --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/ \ + --certificate-oidc-issuer https://token.actions.githubusercontent.com Where `` is the release version of Bandit.