Skip to content

Commit b17c102

Browse files
committed
docs: update for probitas monorepo migration
The probitas project migrated from separate probitas-test/cli repo to monorepo at probitas-test/probitas. Updated all references: - Installation URLs from cli/main to probitas/main - Nix flake input from probitas-test/cli to probitas-test/probitas - Added GitHub Actions setup-probitas documentation Also fixed Nix flake.nix to avoid name collision when using overlays. The input name "probitas" shadowed the package name in lexical scope, causing "with pkgs; probitas" to reference the flake input instead of the overlay-provided package. Renamed input to "probitas-flake" to resolve the conflict and enable overlay usage with "with pkgs;" syntax.
1 parent ad1df0b commit b17c102

4 files changed

Lines changed: 127 additions & 48 deletions

File tree

docs/installation.md

Lines changed: 54 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ Requires [Deno](https://deno.land/) v2.x or later.
99
Install the CLI using the shell installer:
1010

1111
```bash
12-
curl -fsSL https://raw.githubusercontent.com/probitas-test/cli/main/install.sh | bash
12+
curl -fsSL https://raw.githubusercontent.com/probitas-test/probitas/main/install.sh | bash
1313
```
1414

1515
### Options
@@ -18,10 +18,10 @@ Configure installation via environment variables:
1818

1919
```bash
2020
# Install specific version
21-
curl -fsSL https://raw.githubusercontent.com/probitas-test/cli/main/install.sh | PROBITAS_VERSION=0.7.3 bash
21+
curl -fsSL https://raw.githubusercontent.com/probitas-test/probitas/main/install.sh | PROBITAS_VERSION=0.7.1 bash
2222

2323
# Install to custom directory
24-
curl -fsSL https://raw.githubusercontent.com/probitas-test/cli/main/install.sh | PROBITAS_INSTALL_DIR=/usr/local/bin bash
24+
curl -fsSL https://raw.githubusercontent.com/probitas-test/probitas/main/install.sh | PROBITAS_INSTALL_DIR=/usr/local/bin bash
2525
```
2626

2727
## Homebrew (macOS/Linux)
@@ -46,15 +46,15 @@ The Probitas CLI provides a Nix flake with multiple usage patterns.
4646
Execute `probitas` directly without installing:
4747

4848
```bash
49-
nix run github:probitas-test/cli
49+
nix run github:probitas-test/probitas
5050
```
5151

5252
### Install to Profile
5353

5454
Install into your Nix profile for persistent access:
5555

5656
```bash
57-
nix profile install github:probitas-test/cli
57+
nix profile install github:probitas-test/probitas
5858
```
5959

6060
### Add to Project's flake.nix
@@ -65,24 +65,20 @@ Add Probitas to your project's development environment using the overlay:
6565
{
6666
inputs = {
6767
nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
68+
probitas-flake.url = "github:probitas-test/probitas";
6869
flake-utils.url = "github:numtide/flake-utils";
69-
probitas.url = "github:probitas-test/cli";
70-
probitas.inputs.nixpkgs.follows = "nixpkgs";
71-
probitas.inputs.flake-utils.follows = "flake-utils";
7270
};
7371
74-
outputs = { self, nixpkgs, flake-utils, probitas }:
72+
outputs = { nixpkgs, probitas-flake, flake-utils, ... }:
7573
flake-utils.lib.eachDefaultSystem (system:
7674
let
7775
pkgs = import nixpkgs {
7876
inherit system;
79-
overlays = [ probitas.overlays.default ];
77+
overlays = [ probitas-flake.overlays.default ];
8078
};
8179
in {
8280
devShells.default = pkgs.mkShell {
83-
packages = with pkgs; [
84-
probitas
85-
];
81+
packages = with pkgs; [ probitas ];
8682
};
8783
});
8884
}
@@ -100,7 +96,7 @@ The overlay pattern integrates `probitas` directly into your `pkgs`, enabling
10096
cleaner configuration:
10197

10298
```nix
103-
overlays = [ probitas.overlays.default ];
99+
overlays = [ probitas-flake.overlays.default ];
104100
# ...
105101
packages = with pkgs; [ probitas ]; # probitas is now part of pkgs
106102
```
@@ -116,8 +112,8 @@ The `inputs.follows` directive ensures Probitas uses your project's nixpkgs
116112
version instead of its own pinned version:
117113

118114
```nix
119-
probitas.inputs.nixpkgs.follows = "nixpkgs";
120-
probitas.inputs.flake-utils.follows = "flake-utils";
115+
probitas-flake.inputs.nixpkgs.follows = "nixpkgs";
116+
probitas-flake.inputs.flake-utils.follows = "flake-utils";
121117
```
122118

123119
Benefits:
@@ -131,13 +127,13 @@ Benefits:
131127
Lock to a specific CLI version using a commit hash or tag:
132128

133129
```nix
134-
probitas.url = "github:probitas-test/cli/v0.7.3";
130+
probitas-flake.url = "github:probitas-test/probitas/v0.7.1";
135131
```
136132

137133
Or using a commit:
138134

139135
```nix
140-
probitas.url = "github:probitas-test/cli/abc1234";
136+
probitas-flake.url = "github:probitas-test/probitas/abc1234";
141137
```
142138

143139
### Flake Outputs Reference
@@ -152,6 +148,46 @@ The Probitas CLI flake provides:
152148
| `apps.${system}.default` | App for `nix run` |
153149
| `devShells.${system}.default` | Development shell |
154150

151+
## GitHub Actions
152+
153+
### Using setup-probitas Action
154+
155+
The recommended way to use Probitas in GitHub Actions:
156+
157+
```yaml
158+
- uses: probitas-test/setup-probitas@v1
159+
with:
160+
version: latest # or specific version like '0.7.1'
161+
162+
- name: Run scenarios
163+
run: probitas run
164+
```
165+
166+
See
167+
[probitas-test/setup-probitas](https://github.com/probitas-test/setup-probitas)
168+
for full documentation.
169+
170+
### Using Nix in GitHub Actions
171+
172+
For projects using Nix flakes with
173+
[nixbuild/nix-quick-install-action](https://github.com/nixbuild/nix-quick-install-action):
174+
175+
```yaml
176+
- uses: nixbuild/nix-quick-install-action@v34
177+
178+
- name: Run scenarios
179+
run: nix run github:probitas-test/probitas -- run
180+
```
181+
182+
Or within a Nix development shell:
183+
184+
```yaml
185+
- uses: nixbuild/nix-quick-install-action@v34
186+
187+
- name: Run scenarios
188+
run: nix develop -c probitas run
189+
```
190+
155191
## Verify Installation
156192
157193
After installation, verify the CLI is working:

docs/overview.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,13 @@ Install the CLI to run scenarios. Choose your preferred method:
2020

2121
```bash
2222
# Shell installer (requires Deno v2.x+)
23-
curl -fsSL https://raw.githubusercontent.com/probitas-test/cli/main/install.sh | bash
23+
curl -fsSL https://raw.githubusercontent.com/probitas-test/probitas/main/install.sh | bash
2424

2525
# Homebrew (macOS/Linux)
2626
brew install probitas-test/tap/probitas
2727

2828
# Nix
29-
nix run github:probitas-test/cli
29+
nix run github:probitas-test/probitas
3030
```
3131

3232
See [Installation Guide](/docs/installation/) for detailed options including Nix

flake.lock

Lines changed: 61 additions & 16 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

flake.nix

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,25 +3,23 @@
33

44
inputs = {
55
nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
6+
probitas-flake.url = "github:probitas-test/probitas";
67
flake-utils.url = "github:numtide/flake-utils";
7-
probitas.url = "github:probitas-test/cli";
8-
probitas.inputs.nixpkgs.follows = "nixpkgs";
9-
probitas.inputs.flake-utils.follows = "flake-utils";
108
};
119

12-
outputs = { self, nixpkgs, flake-utils, probitas }:
10+
outputs = { nixpkgs, probitas-flake, flake-utils, ... }:
1311
flake-utils.lib.eachDefaultSystem (system:
1412
let
15-
pkgs = import nixpkgs { inherit system; };
16-
probitasPkg = probitas.packages.${system}.probitas;
13+
pkgs = import nixpkgs {
14+
inherit system;
15+
overlays = [ probitas-flake.overlays.default ];
16+
};
1717
in {
18-
packages.default = probitasPkg;
19-
2018
devShells.default = pkgs.mkShell {
21-
packages = [
22-
pkgs.deno
23-
pkgs.pagefind
24-
probitasPkg
19+
packages = with pkgs; [
20+
deno
21+
pagefind
22+
probitas
2523
];
2624

2725
shellHook = ''

0 commit comments

Comments
 (0)