include mamba as requirement repo for dev setup (#528)

conda · Sep 20, 2024 · 634cda8 · 634cda8
1 parent d3a1f50
commit 634cda8
Show file tree

Hide file tree

Showing 2 changed files with 24 additions and 6 deletions.
diff --git a/docs/dev/setup.md b/docs/dev/setup.md
@@ -5,9 +5,9 @@
 The development workflow is streamlined for Linux thanks to the `devcontainer` configuration
 bundled in this repository. You'll need Docker and VS Code with the [Dev Containers extension](https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers):
 
-1. Clone `conda/conda` and `conda/conda-libmamba-solver` to your preferred locations
-   (e.g. `~/devel/conda` and `~/devel/conda-libmamba-solver`, respectively).
-   The location does not matter as long as both repositories have the same parent directory.
+1. Clone `conda/conda`, `mamba-org/mamba` and `conda/conda-libmamba-solver` to your preferred locations
+   (e.g. `~/devel/conda`, `~/devel/mamba` and `~/devel/conda-libmamba-solver`, respectively).
+   The location does not matter as long as all repositories have the same parent directory.
 2. Open your `conda-libmamba-solver` clone with VS Code.
 3. Connect to the DevContainer image via the bottom-left menu (<kbd>❱❰</kbd>) and
    click on "Reopen in Container". Pick one of the suggested configurations:
@@ -31,9 +31,8 @@ If you are modifying C++ sources, re-run `develop-mamba` to rebuild the librarie
 
 You can reuse the devcontainer scripts with regular Docker too.
 
-1. Clone `conda/conda` and `conda/conda-libmamba-solver` to your preferred locations
-   (e.g. `~/devel/conda` and `~/devel/conda-libmamba-solver`, respectively).
-   You should also clone `mamba-org/mamba` if you need to develop `libmamba`.
+1. Clone `conda/conda`, `mamba-org/mamba` and `conda/conda-libmamba-solver` to your preferred locations
+   (e.g. `~/devel/conda`, `~/devel/mamba` and `~/devel/conda-libmamba-solver`, respectively).
    The location does not matter as long as all repositories have the same parent directory.
 2. Start a new Docker instance with this command. Adjust the local mounts as necessary.
 

diff --git a/news/528-include-mamba-as-required-repo-for-dev-setup b/news/528-include-mamba-as-required-repo-for-dev-setup
@@ -0,0 +1,19 @@
+### Enhancements
+
+* <news item>
+
+### Bug fixes
+
+* <news item>
+
+### Deprecations
+
+* <news item>
+
+### Docs
+
+* Include mamba-org/mamba as a required cloned repository for setting up a dev environment. (#528)
+
+### Other
+
+* <news item>