chore(docs): Added README

.cargo/config.toml

@@ -1,8 +1,5 @@
 [alias]
 xtask = "run --package xtask --"
 
-[registry]
-default = "huizinga"
-
-[registries.huizinga]
+[registries.infra]
 index = "sparse+https://git.huizinga.dev/api/packages/infra/cargo/"

.gitea/workflows/release.yaml

@@ -6,33 +6,32 @@ on:
       - main
 
 jobs:
-  # TODO: Uncomment in initial release commit
-  # release-plz:
-  #   name: Release-plz Release
-  #   runs-on: ubuntu-latest
-  #   permissions:
-  #     contents: write
-  #     pull-requests: read
-  #   steps:
-  #     - &checkout
-  #       uses: actions/checkout@v6
-  #       with:
-  #         fetch-depth: 0
-  #         persist-credentials: false
-  #     - uses: dtolnay/rust-toolchain@nightly
-  #     - uses: Swatinem/rust-cache@v2
-  #     - uses: taiki-e/install-action@v2
-  #       with:
-  #         tool: release-plz
-  #     - &git-setup
-  #       name: Configure git
-  #       run: |
-  #         git config user.name "Release-plz"
-  #         git config user.email "release-plz@noreply.huizinga.dev"
-  #         git config url.https://${{ gitea.actor }}:${{ secrets.GITEA_TOKEN }}@git.huizinga.dev/.insteadOf https://git.huizinga.dev/
-  #     - env:
-  #         CARGO_REGISTRIES_HUIZINGA_TOKEN: "Bearer ${{ secrets.REGISTRY_TOKEN }}"
-  #       run: release-plz release --git-token "${{ secrets.GITEA_TOKEN }}" --forge gitea
+  release-plz:
+    name: Release-plz Release
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: read
+    steps:
+      - &checkout
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+          persist-credentials: false
+      - uses: dtolnay/rust-toolchain@nightly
+      - uses: Swatinem/rust-cache@v2
+      - uses: taiki-e/install-action@v2
+        with:
+          tool: release-plz
+      - &git-setup
+        name: Configure git
+        run: |
+          git config user.name "Release-plz"
+          git config user.email "release-plz@noreply.huizinga.dev"
+          git config url.https://${{ gitea.actor }}:${{ secrets.GITEA_TOKEN }}@git.huizinga.dev/.insteadOf https://git.huizinga.dev/
+      - env:
+          CARGO_REGISTRIES_INFRA_TOKEN: "Bearer ${{ secrets.REGISTRY_TOKEN }}"
+        run: release-plz release --git-token "${{ secrets.GITEA_TOKEN }}" --forge gitea --dry-run
 
   release-plz-pr:
     name: Release-plz PR

Cargo.toml

@@ -3,7 +3,7 @@ name = "crete"
 version = "0.1.0"
 edition = "2024"
 default-run = "crete"
-publish = ["huizinga"]
+publish = ["infra"]
 
 [workspace]
 members = ["xtask"]

README.md

@@ -2,3 +2,18 @@
 
 A tool that takes node and cluster configs and uses it to generate talos configs
 and render jinja templates.
+
+## Installation
+
+Add the following to `~/.cargo.config.toml`:
+
+```toml
+[registries.infra]
+index = "sparse+https://git.huizinga.dev/api/packages/infra/cargo/"
+```
+
+You can then install `crete` by running:
+
+```bash
+cargo install --registry infra crete
+```