fix: improvements and deploy container (#3)

- Add deploy image and correct various stuff.

Author: gabyx

.gitignore

@@ -21,6 +21,7 @@
 .prettierrc.yaml
 .yamllint.yaml
 .typos.toml
+.ruff-cache
 
 # General build folder.
 .output

README.md

@@ -73,18 +73,39 @@ following features.
 
 # Usage
 
+## With Container
+
+```bash
+mkdir repo
+podman run -it -v "$(pwd)/repo:/workspace" \
+  ghcr.io/sdsc-ordes/repository-template:latest \
+  -t "<language>" -d "." [-- ["args-to-copier"...]]
+```
+
+> [!WARNING]
+>
+> **DO NOT try to use `docker`** (and for other things too 😆) for the above, it
+> does not do
+> [user namespacing](https://docs.docker.com/engine/security/userns-remap/) and
+> it will create `root`-owned files. We do not support this now. Just use
+> `podman`!
+
+See [arguments explanations here](#arguments).
+
 ## Cloning
 
 Clone this repository to some place of your choice.
 
 Apply the templates with `copier` using the following:
 
-```shell
+```bash
 cd repo && git pull
-just create <language> <destination> [args...]
+just create -t "<language>" -d "<destination>" [-- ["args-to-copier"...]]
 ```
 
-where
+See [arguments explanations here](#arguments).
+
+## Arguments
 
 - `<destination>` is the destination folder where you want to place this new
   repository.
@@ -97,8 +118,13 @@ where
   - [`rust`](./src/rust): For a Rust toolchain with `cargo`
   - [`go`](./src/go): For a default Go toolchain.
 
-- `[args...]` are optional arguments passed to `copier`. If you want to
-  overwrite by default use `-w` and not answer `Y` all the time.
+- `[args-to-copier...]` are optional arguments passed to `copier`. If you want
+  to overwrite by default use `-w` and not answer `Y` all the time and `-l` to
+  apply all defaults to inspect:
+
+  ```shell
+  just create -t <language> -d <destination> -- -w -l
+  ```
 
 ## Containerized
 

docs/development-guide.md

@@ -18,3 +18,14 @@ Other scopes then the one in the specification are:
 - `python`: If the commit targets only the `python` template.
 - `rust`: If the commit targets only the `rust` template.
 - `go`: If the commit targets only the `go` template.
+
+## Testing
+
+Run
+
+```shell
+just test-all
+```
+
+To update the Nix Flakes, run
+`REPOSITORY_TEMPLATE_UPDATE_FLAKES=true just test-all`.

justfile

@@ -3,76 +3,49 @@ set shell := ["bash", "-cue"]
 comp_dir := justfile_directory()
 root_dir := `git rev-parse --show-toplevel`
 output_dir := root_dir / ".output"
-flake_dir := "./tools/nix"
+flake_dir := root_dir / "./tools/nix"
+
+mod maintenance "./tools/just/maintenance.just"
 
 # Default target if you do not specify a target.
 default:
-    just --list
+    just --list --unsorted
 
 # Create a new project from a template.
-create template="python" output_dir="build":
-    just develop just create-impl "$@"
-
-# Create a new project from a template with all default answers.
-create-default template="python" output_dir="build":
-    just develop just create-impl "$@" -l
-
-[private]
-create-impl *args:
-    #!/usr/bin/env bash
-    set -eu
-    source ./tools/ci/general.sh
-
-    template="$1"
-    destination="$(realpath "$2")" # Make absolute (resolve symlinks etc...)
-    args=("${@:3}")
+create *args:
+    just develop ./tools/scripts/create.sh "$@"
 
-    [[ "$template" =~ generic|rust|go|python ]] ||
-        ci::die "No such template '$template' to template"
-
-    mkdir -p "$destination"
-    cd "{{root_dir}}"
-
-    ci::print_info "Rendering 'generic' template ... "
-    copier copy --trust "${args[@]}" \
-        "src/generic" "$destination" \
-        --data "project_language=$template" ||
-        ci::die "Could not apply template '$template'."
-    ci::print_info "Rendering 'generic' template completed."
+# Format the whole repository.
+format *args:
+    "{{root_dir}}/tools/scripts/setup-config-files.sh"
+    nix run --accept-flake-config {{flake_dir}}#treefmt -- "$@"
 
-    if [ "$template" != "generic" ]; then
-        answer_file="$destination/tools/configs/copier/answers/generic.yaml"
+# Setup the repository.
+setup *args:
+   just maintenance::setup "$@"
 
-        ci::print_info "Rendering '$template' template ..."
-        copier copy --trust "${args[@]}" \
-            "src/$template" "$destination" \
-            --data "project_authors=$(yq -r ".project_authors" "$answer_file")" \
-            --data "project_hosts=$(yq -r ".project_hosts" "$answer_file")" \
-            --data "project_version=$(yq -r ".project_version" "$answer_file")" \
-            --data "project_description=$(yq -r ".project_description" "$answer_file")" \
-            --data "project_url=$(yq -r ".project_url" "$answer_file")" ||
-            ci::die "Could not apply template '$template'."
-        ci::print_info "Rendering '$template' template completed."
-    fi
+# Clean output folder.
+clean:
+    rm -rf ./.output
 
-    if ! git -C "$destination" rev-parse --show-toplevel &>/dev/null; then
-        # If we are not inside a Git repo we need to init.
-        ci::print_info "Initializing Git repo '$destination'"
-        git -C  "$destination" init || ci::die "Could not initialize Git repo."
-    fi
+# Test a template.
+test template="python":
+   just maintenance::test "{{template}}"
 
-    if [ "$(git -C "$destination" rev-parse --show-toplevel 2>/dev/null)" == "$destination" ]; then
-        # If we are inside the top level, add the files directly.
-        ci::print_info "Staging all files."
-        git -C "$destination" add . || ci::die "Could not stage all files."
-    fi
+# Test everything.
+test-all:
+   just maintenance::test-all
 
+# Show all packages configured in the Nix `flake.nix`.
+nix-list *args:
+    cd tools/nix && nix flake --no-pure-eval show
 
 # Enter the default Nix development shell.
 develop *args:
     just nix-develop default "$@"
 
 # Enter the Nix development shell `$1` and execute the command `${@:2}`.
+[private]
 nix-develop *args:
     #!/usr/bin/env bash
     set -eu
@@ -82,131 +55,3 @@ nix-develop *args:
     nix develop --no-pure-eval --accept-flake-config \
         "{{flake_dir}}#$shell" \
         --command "${args[@]}"
-
-# Format the whole repository.
-format *args:
-    "{{root_dir}}/tools/scripts/setup-config-files.sh"
-    nix run --accept-flake-config {{flake_dir}}#treefmt -- "$@"
-
-# Setup the repository.
-setup *args:
-    ./tools/scripts/setup.sh
-
-# Test all templates.
-test-all:
-    just test generic
-    just test python
-    just test rust
-
-# Test the code scaffolding.
-test template="python": setup
-    #!/usr/bin/env bash
-    set -eu
-    source "{{root_dir}}/tools/ci/general.sh"
-
-    ci::print_info "Running test '{{template}}'"
-    ci::print_info "======================"
-    build_dir="{{output_dir}}/{{template}}"
-    cd "{{root_dir}}" && rm -rf "$build_dir"
-
-    uv run copier copy --trust -w  \
-        --data "project_language={{template}}" \
-        --defaults  \
-        src/generic \
-        "$build_dir"
-
-    if [ "{{template}}" != "generic" ]; then
-        answer_file="$build_dir/tools/configs/copier/answers/generic.yaml"
-        uv run copier copy --trust -w \
-            --data "project_authors=$(yq -r ".project_authors" "$answer_file")" \
-            --data "project_hosts=$(yq -r ".project_hosts" "$answer_file")" \
-            --data "project_version=$(yq -r ".project_version" "$answer_file")" \
-            --data "project_description=$(yq -r ".project_description" "$answer_file")" \
-            --data "project_url=$(yq -r ".project_url" "$answer_file")" \
-            --defaults \
-            "src/{{template}}" \
-            "$build_dir"
-    fi
-
-    # Test the templated output.
-    cd "${build_dir}" &&
-        git init && git add . && \
-        git commit -a -m "init"
-
-    just develop just setup
-    just develop just format
-    just develop just lint
-    just develop just build
-    just develop just run
-
-    cp tools/nix/flake.lock "{{root_dir}}/src/{{template}}/tools/nix/flake.lock"
-    if [ "{{template}}" == "python" ]; then
-        cp uv.lock "{{root_dir}}/src/{{template}}/uv.lock"
-    elif [ "{{template}}" == "go" ]; then
-        cp go.work.sum "{{root_dir}}/src/{{template}}/go.work.sum"
-        cp src/tool/go.sum "{{root_dir}}/src/{{template}}/src/{{{{ package_name }}/go.sum"
-    elif [ "{{template}}" == "rust" ]; then
-        cp Cargo.lock "{{root_dir}}/src/{{template}}/Cargo.lock"
-    fi
-
-    git clean -df
-
-    if ! git diff --exit-code --quiet . ; then
-        echo "We have changes in the build folder."
-    fi
-
-# Create and upload the code scaffolding.
-upload-all template="python":
-    just upload generic
-    just upload rust
-    just upload go
-    just upload python
-
-# Create and upload the code scaffolding.
-upload template="python": setup
-    #!/usr/bin/env bash
-    set -eu
-    source "{{root_dir}}/tools/ci/general.sh"
-
-    temp_dir=$(mktemp -d)
-    function cleanup() {
-        [ ! -d "$temp_dir" ] || {
-            ci::print_info "removing temp dir"
-            rm -rf "$temp_dir"
-        }
-    }
-    trap cleanup EXIT
-
-    ci::print_info "Upload '{{template}}'"
-    ci::print_info "======================"
-    build_dir="$temp_dir/{{template}}"
-
-    cd "{{root_dir}}" && rm -rf "$build_dir" && mkdir -p "$build_dir"
-    just create-impl "{{template}}" "$build_dir" -l -f
-
-    cd "$build_dir"
-
-    # Add WARNING
-    cat <(
-        echo "> [!WARNING]"
-        echo "> This is a demo rendering of the [\`{{template}}\` template here](https://github.com/sdsc-ordes/repository-template#{{template}}-template)"
-        echo
-        cat README.md
-    ) > README.md.mod  && mv README.md.mod README.md
-
-    git init &&
-      just format &&
-      git add . &&
-      git commit -a -m "init"
-
-    git remote add origin \
-        "https://github.com/sdsc-ordes/repository-template-{{template}}.git"
-
-    branch="main"
-    if ! ci::is_running; then
-        branch="test"
-        git switch -c "$branch"
-    fi
-
-    git checkout "$branch"
-    git push origin --force

src/.jinja/common/justfile

@@ -8,7 +8,7 @@ build_dir := output_dir / "build"
 
 # Default target if you do not specify a target.
 default:
-    just --list
+    just --list --unsorted
 
 # Enter the default Nix development shell and execute the command `"$@`.
 develop *args:
@@ -23,6 +23,9 @@ format *args:
 setup *args:
     cd "{{root_dir}}" && ./tools/scripts/setup.sh
 
+# Show all packages configured in the Nix `flake.nix`.
+nix-list *args:
+    cd tools/nix && nix flake --no-pure-eval show
 
 # Enter the Nix `devShell` with name `$1` and execute the command `${@:2}` (default command is '$SHELL')
 [private]