Skip to content

Commit a0426e7

Browse files
committed
docs: Remove WinGet from install instructions until registry submission
WinGet manifests are still generated by CI but DoiT.dci is not yet registered in the WinGet registry. Drop WinGet references from user-facing docs and clarify the status in Known Limitations. Also add CLAUDE.md with project context for Claude Code sessions.
1 parent feb52e0 commit a0426e7

3 files changed

Lines changed: 36 additions & 10 deletions

File tree

CLAUDE.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# Claude Code Project Context
2+
3+
## What Is This
4+
5+
`dci` is the CLI for the DoiT Cloud Intelligence (DCI) API. It wraps [restish](https://github.com/rest-sh/restish) with DCI-specific configuration — auto-configured API base, OAuth2 via the DoiT Console, table-first output, and a locked-down command surface that exposes only DCI API operations. The entire CLI is a single `main.go` file. It ships as a Go binary distributed via Homebrew, Scoop, WinGet, and `.deb`/`.rpm` packages.
6+
7+
## Commit Message Conventions
8+
9+
GoReleaser changelog auto-generates from commits between tags. Filtered prefixes (excluded from changelog):
10+
- `docs:` — documentation-only changes (README, DISTRIBUTION.md, etc.)
11+
- `test:` — test-only changes
12+
- `chore:` — maintenance (manifest updates, CI config, dependency bumps)
13+
14+
Commits without these prefixes appear in the GitHub Release changelog. Use prefixes deliberately.
15+
16+
## Release Pipeline
17+
18+
- GoReleaser v2 via `goreleaser-cross` Docker image
19+
- Tag `v*` triggers `release.yml``sync-manifests.yml` + `post-release-verify.yml`
20+
- Manifests (`Formula/dci.rb`, `bucket/dci.json`) are committed to main by CI
21+
- WinGet manifests generated but require manual PR to `microsoft/winget-pkgs`
22+
23+
## Key Files
24+
25+
- Single-file CLI: `main.go` (all logic) + `main_test.go`
26+
- Build config: `.goreleaser.yaml`
27+
- Release workflows: `.github/workflows/release.yml`, `sync-manifests.yml`, `post-release-verify.yml`
28+
- Package templates: `packaging/`
29+
30+
## Project Conventions
31+
32+
- README and DISTRIBUTION.md are user-facing — no internal jargon, no restish references
33+
- README targets end users; DISTRIBUTION.md targets developers/contributors
34+
- Homebrew tap works via GitHub redirect (`doitintl/homebrew-dci-cli``doitintl/dci-cli`)
35+
- Windows ARM64 excluded (upstream goreleaser-cross issue #117)

DISTRIBUTION.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,6 @@ This document covers how `dci` releases are built, published, and distributed ac
88
|------------------|---------------------------------------------------------------------------------|
99
| GitHub Releases | Download from [Releases](https://github.com/doitintl/dci-cli/releases/latest) |
1010
| Homebrew (macOS) | `brew install doitintl/dci-cli/dci` |
11-
| WinGet (Windows) | `winget install DoiT.dci` |
1211
| Scoop (Windows) | `scoop bucket add doitintl https://github.com/doitintl/dci-cli && scoop install dci` |
1312
| Linux (.deb) | `sudo dpkg -i dci_*_linux_amd64.deb` |
1413
| Linux (.rpm) | `sudo rpm -i dci_*_linux_amd64.rpm` |
@@ -71,8 +70,6 @@ Both `sync-manifests.yml` and `post-release-verify.yml` support `workflow_dispat
7170
1. Delete the GitHub release: `gh release delete vX.Y.Z`
7271
2. Delete the tag: `git push --delete origin vX.Y.Z && git tag -d vX.Y.Z`
7372
3. Revert manifests — push a commit restoring the previous `Formula/dci.rb` and `bucket/dci.json`, or re-run `sync-manifests.yml` for the last good tag.
74-
4. If a WinGet manifest was already submitted to `microsoft/winget-pkgs`, open a revert PR there.
75-
7673
To re-release: fix the issue, tag a new patch version, and push.
7774

7875
## Troubleshooting
@@ -89,5 +86,5 @@ To re-release: fix the issue, tag a new patch version, and push.
8986
## Known Limitations
9087

9188
- **Windows ARM64** is excluded due to a missing cross-compiler in `goreleaser-cross` ([goreleaser-cross#117](https://github.com/goreleaser/goreleaser-cross/issues/117)).
92-
- **WinGet** manifests are generated but not auto-submitted — they need manual PR submission to `microsoft/winget-pkgs`.
89+
- **WinGet** manifests are generated by CI as workflow artifacts (`packaging/winget/*.tmpl`), but `DoiT.dci` is not yet registered in the WinGet registry. To enable `winget install DoiT.dci`, the rendered manifests need to be submitted as a PR to [microsoft/winget-pkgs](https://github.com/microsoft/winget-pkgs). Until then, WinGet is omitted from install instructions.
9390
- **Homebrew tap** relies on a GitHub redirect from `doitintl/homebrew-dci-cli` to this repo. Do not create a repo named `homebrew-dci-cli` in the org.

README.md

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,6 @@
88
# macOS (Homebrew)
99
brew install doitintl/dci-cli/dci
1010

11-
# Windows (WinGet)
12-
winget install DoiT.dci
13-
1411
# Windows (Scoop)
1512
scoop bucket add doitintl https://github.com/doitintl/dci-cli
1613
scoop install dci
@@ -78,9 +75,6 @@ dci list-budgets --table-columns id,name,amount
7875
# macOS (Homebrew)
7976
brew update && brew upgrade dci
8077

81-
# Windows (WinGet)
82-
winget upgrade DoiT.dci
83-
8478
# Windows (Scoop)
8579
scoop update dci
8680
```

0 commit comments

Comments
 (0)