Collapse long sections in bootstrapped READMEs

.last-exported-commit

@@ -1 +1 @@
-Last exported commit from parent repo: b57aeaf5d7c5e2415726281a50cb812207142125
+Last exported commit from parent repo: 7e86c3a08ceba201c906c5f28e28f3f87ccc4684

nix-bootstrap.cabal

@@ -5,7 +5,7 @@ cabal-version: 2.0
 -- see: https://github.com/sol/hpack
 
 name:           nix-bootstrap
-version:        1.5.3.1
+version:        1.5.4.0
 author:         gchquser
 maintainer:     [email protected]
 copyright:      Crown Copyright

package.yaml

@@ -12,7 +12,7 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 name: nix-bootstrap
-version: 1.5.3.1
+version: 1.5.4.0
 author: gchquser
 maintainer: [email protected]
 copyright: Crown Copyright

src/Bootstrap/Data/Bootstrappable/Readme.hs

@@ -57,6 +57,10 @@ instance Bootstrappable Readme where
         <> ( [ "",
                "## Development Environment",
                "",
+               "<details>",
+               "<summary>Expand development environment setup instructions</summary>",
+               "<p>",
+               "",
                "You can work on "
                  <> unProjectName readmeProjectName
                  <> " in "
@@ -123,6 +127,10 @@ instance Bootstrappable Readme where
                  ]
                else []
            )
+        <> [ "",
+             "</p>",
+             "</details>"
+           ]
         <> ( case readmeProjectType of
                Elm ElmOptions {..} ->
                  [""]
@@ -218,13 +226,21 @@ instance Bootstrappable Readme where
                  [ "",
                    "## Project Structure",
                    "",
+                   "<details>",
+                   "<summary>Expand project structure tree</summary>",
+                   "<p>",
+                   "",
                    "The following diagram explains how nix-bootstrap has laid out your infrastructure.",
                    "Feel free to remove this once you're familiar with how it works, or amend it as you grow your project.",
                    "",
                    "```plaintext"
                  ]
                    <> lines (toText . drawTree $ toReasonTree buildPlan)
-                   <> ["```"]
+                   <> [ "```",
+                        "",
+                        "</p>",
+                        "</details>"
+                      ]
                Nothing -> []
            )
         <> [ "",

test/Bootstrap/Data/Bootstrappable/ReadmeSpec.hs

@@ -55,6 +55,10 @@ spec = describe "README.md rendering" do
 
 ## Development Environment
 
+<details>
+<summary>Expand development environment setup instructions</summary>
+<p>
+
 You can work on test_name in 2 ways:
 
   * [In GitPod](#use-in-gitpod)
@@ -84,6 +88,9 @@ To develop with this project in GitPod, follow the instructions below:
 
 _After following the steps above, you will be able to use any of the project's tools mentioned below when in the project folders; direnv will automatically make the tools available when you `cd` into the project._
 
+</p>
+</details>
+
 ## Running a Development Server
 
 To run a development server, use the `dev` script defined in `package.json`.
@@ -108,6 +115,10 @@ This will produce a `dist` directory with a built web app.
 
 ## Project Structure
 
+<details>
+<summary>Expand project structure tree</summary>
+<p>
+
 The following diagram explains how nix-bootstrap has laid out your infrastructure.
 Feel free to remove this once you're familiar with how it works, or amend it as you grow your project.
 
@@ -123,6 +134,9 @@ Feel free to remove this once you're familiar with how it works, or amend it as
    `- sources.nix - This is the interface between nix and the dependencies listed in sources.json.
 ```
 
+</p>
+</details>
+
 ## nix-bootstrap
 
 This project was bootstrapped by [nix-bootstrap](https://github.com/gchq/nix-bootstrap/).
@@ -151,6 +165,10 @@ If you'd like to learn more about how the generated infrastructure works, or hav
 
 ## Development Environment
 
+<details>
+<summary>Expand development environment setup instructions</summary>
+<p>
+
 You can work on test_name in 2 ways:
 
   * [In GitPod](#use-in-gitpod)
@@ -180,6 +198,9 @@ To develop with this project in GitPod, follow the instructions below:
 
 _After following the steps above, you will be able to use any of the project's tools mentioned below when in the project folders; direnv will automatically make the tools available when you `cd` into the project._
 
+</p>
+</details>
+
 ## Using the Repl
 
 You can use the provided Haskell repl by running `cabal repl` in the dev shell.
@@ -212,6 +233,10 @@ If you'd like to learn more about how the generated infrastructure works, or hav
 
 ## Development Environment
 
+<details>
+<summary>Expand development environment setup instructions</summary>
+<p>
+
 You can work on test_name in 2 ways:
 
   * [In GitPod](#use-in-gitpod)
@@ -241,6 +266,9 @@ To develop with this project in GitPod, follow the instructions below:
 
 _After following the steps above, you will be able to use any of the project's tools mentioned below when in the project folders; direnv will automatically make the tools available when you `cd` into the project._
 
+</p>
+</details>
+
 ## Using your project
 
 1. Generate a cabal file by running `hpack`
@@ -276,6 +304,10 @@ If you'd like to learn more about how the generated infrastructure works, or hav
 
 ## Development Environment
 
+<details>
+<summary>Expand development environment setup instructions</summary>
+<p>
+
 You can work on test_name in 3 ways:
 
   * [In GitPod](#use-in-gitpod)
@@ -320,8 +352,15 @@ _After following the steps above, you will be able to use any of the project's t
 
 _After following the steps above, you will be able to use any of the project's tools mentioned below when in the integrated terminal of Visual Studio Code._
 
+</p>
+</details>
+
 ## Project Structure
 
+<details>
+<summary>Expand project structure tree</summary>
+<p>
+
 The following diagram explains how nix-bootstrap has laid out your infrastructure.
 Feel free to remove this once you're familiar with how it works, or amend it as you grow your project.
 
@@ -337,6 +376,9 @@ Feel free to remove this once you're familiar with how it works, or amend it as
    `- sources.nix - This is the interface between nix and the dependencies listed in sources.json.
 ```
 
+</p>
+</details>
+
 ## nix-bootstrap
 
 This project was bootstrapped by [nix-bootstrap](https://github.com/gchq/nix-bootstrap/).
@@ -358,6 +400,10 @@ If you'd like to learn more about how the generated infrastructure works, or hav
 
 ## Development Environment
 
+<details>
+<summary>Expand development environment setup instructions</summary>
+<p>
+
 You can work on test_name in 2 ways:
 
   * [In GitPod](#use-in-gitpod)
@@ -387,6 +433,9 @@ To develop with this project in GitPod, follow the instructions below:
 
 _After following the steps above, you will be able to use any of the project's tools mentioned below when in the project folders; direnv will automatically make the tools available when you `cd` into the project._
 
+</p>
+</details>
+
 ## nix-bootstrap
 
 This project was bootstrapped by [nix-bootstrap](https://github.com/gchq/nix-bootstrap/).
@@ -408,6 +457,10 @@ If you'd like to learn more about how the generated infrastructure works, or hav
 
 ## Development Environment
 
+<details>
+<summary>Expand development environment setup instructions</summary>
+<p>
+
 You can work on test_name in 2 ways:
 
   * [In GitPod](#use-in-gitpod)
@@ -437,6 +490,9 @@ To develop with this project in GitPod, follow the instructions below:
 
 _After following the steps above, you will be able to use any of the project's tools mentioned below when in the project folders; direnv will automatically make the tools available when you `cd` into the project._
 
+</p>
+</details>
+
 ## Building for Production
 
 To produce a production build as defined in `default.nix`, run `nix-build`.
@@ -464,6 +520,10 @@ If you'd like to learn more about how the generated infrastructure works, or hav
 
 ## Development Environment
 
+<details>
+<summary>Expand development environment setup instructions</summary>
+<p>
+
 You can work on test_name in 2 ways:
 
   * [In GitPod](#use-in-gitpod)
@@ -498,6 +558,9 @@ To develop with this project in GitPod, follow the instructions below:
 
 _After following the steps above, you will be able to use any of the project's tools mentioned below when in the project folders; direnv will automatically make the tools available when you `cd` into the project._
 
+</p>
+</details>
+
 ## Building for Production
 
 To produce a production build as defined in `default.nix`, run `nix build`.
@@ -525,6 +588,10 @@ If you'd like to learn more about how the generated infrastructure works, or hav
 
 ## Development Environment
 
+<details>
+<summary>Expand development environment setup instructions</summary>
+<p>
+
 You can work on test_name in 2 ways:
 
   * [In GitPod](#use-in-gitpod)
@@ -559,6 +626,9 @@ To develop with this project in GitPod, follow the instructions below:
 
 _After following the steps above, you will be able to use any of the project's tools mentioned below when in the project folders; direnv will automatically make the tools available when you `cd` into the project._
 
+</p>
+</details>
+
 ## Adding Python Dependencies
 
 To add python dependencies to the project add them to the 'requirements.txt', in the same format seen in Pip projects.
@@ -595,6 +665,10 @@ If you'd like to learn more about how the generated infrastructure works, or hav
 
 ## Development Environment
 
+<details>
+<summary>Expand development environment setup instructions</summary>
+<p>
+
 You can work on test_name in 2 ways:
 
   * [In GitPod](#use-in-gitpod)
@@ -624,6 +698,9 @@ To develop with this project in GitPod, follow the instructions below:
 
 _After following the steps above, you will be able to use any of the project's tools mentioned below when in the project folders; direnv will automatically make the tools available when you `cd` into the project._
 
+</p>
+</details>
+
 ## Adding Python Dependencies
 
 To add python dependencies to the project add them to the 'requirements.txt', in the same format seen in Pip projects.

vulnerability-whitelist.toml

@@ -131,6 +131,10 @@ comment = "pcre2 is only a build-time dependency so we are not vulnerable to thi
 ["perl"]
 comment = "perl is only a build-time dependency so we are not vulnerable to this attack."
 
+["pip"]
+cve = ["CVE-2023-5752"]
+comment = "Vulnerability is regarding use of pip, not pip itself."
+
 ["safe"]
 comment = "CVEs refer to F-Secure SAFE browser, not this haskell package."