Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -100,15 +100,15 @@ jobs:
shell: bash
run: |
go test -race \
-coverprofile coverage.txt \
-coverprofile coverage.out \
-covermode atomic \
./...

- name: Upload coverage
if: matrix.os == 'ubuntu-latest'
uses: codecov/codecov-action@v4
with:
file: coverage.txt
file: coverage.out
flags: unittests
fail_ci_if_error: false
env:
Expand Down
3 changes: 2 additions & 1 deletion .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
# 1. Checkout at full depth so GoReleaser can read every commit.
# 2. Set up Go with the same version pin as CI.
# 3. Run `goreleaser release --clean` which:
# - Builds all 6 platform binaries (linux/darwin/windows × amd64/arm64)
# - Builds all 5 platform binaries (linux/darwin/windows × amd64/arm64,
# minus the windows/arm64 entry that's excluded in .goreleaser.yaml)
# - Generates SHA256 checksums
# - Creates a GitHub Release with an auto-generated changelog
# - Pushes to the homebrew-tap repo (if HOMEBREW_TAP_TOKEN is set)
Expand Down
6 changes: 4 additions & 2 deletions .goreleaser.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,13 +6,15 @@
# SCOOP_BUCKET_TOKEN — provided by GitHub Actions (per-repo secret)
#
# Outputs:
# - 6 single-binary archives in dist/:
# - 5 single-binary archives in dist/ (windows/arm64 is intentionally
# excluded by the builds[].ignore block — add later if demanded):
# nodeup_<version>_linux_amd64.tar.gz
# nodeup_<version>_linux_arm64.tar.gz
# nodeup_<version>_darwin_amd64.tar.gz
# nodeup_<version>_darwin_arm64.tar.gz
# nodeup_<version>_windows_amd64.zip
# - checksums.txt with SHA256 for every artifact
# - checksums.txt with SHA256 for every artifact (the 6th release
# file, but it's a checksums manifest, not a binary)
# - A GitHub Release titled `v<version>` with changelog and all artifacts
# - A homebrew formula pushed to github.com/dipto0321/homebrew-tap
# - A scoop manifest pushed to github.com/dipto0321/scoop-bucket
Expand Down
21 changes: 21 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -709,6 +709,27 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
dead `confirm := true` / `_ = confirm` lines in `cleanup.go`
and the `_ = yes` line in `upgrade.go` flagged in #61 had
already been removed by #76 / PR #95. Closes #61.
- Bundled CI/release tooling doc-accuracy fixes from issue #69:
`CONTRIBUTING.md` claimed a 10-check matrix including a
nonexistent "CoGitto status check" (contradicting its own
later "Sign-off (future)" section, which correctly notes
CoGitto-style enforcement is "not required today"). Dropped
the bogus check and corrected the matrix count to 9 (5
builds + 1 lint + 3 OS tests). The same paragraph's
description of `make ci` was wrong (omitted `fmt`, misstated
order); now correctly states `tidy fmt vet lint test` and
warns that `fmt` rewrites the working tree in place. The
`make ci` description in `CLAUDE.md` was already correct and
is unchanged. `.goreleaser.yaml`, `.github/workflows/release.yml`,
and `docs/release-checklist.md` all claimed "6 binaries"
attached — the actual matrix (linux/windows/darwin ×
amd64/arm64, minus the documented `windows/arm64` exclusion)
produces 5 archives + checksums.txt; all three are corrected
to say "5 binaries + checksums.txt." `.github/workflows/ci.yml`
was uploading `coverage.txt` to Codecov while the documented
`make test` produces `coverage.out`; renamed to `coverage.out`
so a contributor running the documented `make test` sees the
same filename CI consumes. Closes #69.

## [0.0.0] - 2024-07-01

Expand Down
13 changes: 8 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -73,11 +73,10 @@ config.manager=<name> explicitly, or omit the key for auto-detect.
commitlint rules.
3. **Fill in `.github/PULL_REQUEST_TEMPLATE.md`.** The Type-of-change
checklist maps to the SemVer bump.
4. **CI must be green.** Same 10-check matrix as `main`:
4. **CI must be green.** Same 9-check matrix as `main`:
- 5 builds (linux/darwin × amd64/arm64 + windows/amd64)
- 1 lint (golangci-lint + commitlint)
- 3 OS tests (ubuntu/macos/windows)
- 1 CoGitto status check
5. **Squash-merge with the source branch deleted** — same as PRs #1–#10.
6. **No force-pushes after review.** Force-pushes during authoring are
fine (use `--force-with-lease`).
Expand Down Expand Up @@ -107,9 +106,13 @@ go test ./internal/detector/...
go test ./internal/detector/... -run TestNvm
```

`make ci` runs `tidy`, `vet`, `test`, and `golangci-lint run`. There is
no separate "docs regen" step — docs are pure markdown and updated by
hand in PRs.
`make ci` runs `tidy fmt vet lint test` (in that order). The `fmt`
step rewrites Go files in place (`gofmt -s -w .` + `goimports -w .`),
so run it on a clean tree or be ready to commit the rewrites — a
contributor who only read the previous version of this paragraph
wouldn't expect `make ci` to mutate their working tree. There is
no separate "docs regen" step — docs are pure markdown and updated
by hand in PRs.

## Issue etiquette

Expand Down
2 changes: 1 addition & 1 deletion docs/release-checklist.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ git push origin vX.Y.Z
## Post-tag (release.yml fires automatically)

- [ ] GitHub Release visible at /releases/tag/vX.Y.Z
- [ ] All 6 binaries attached + checksums.txt
- [ ] All 5 binaries attached + checksums.txt
- [ ] Homebrew formula pushed to `dipto0321/homebrew-tap`
- [ ] Scoop manifest pushed to `dipto0321/scoop-bucket`
- [ ] npm wrapper published to the npm registry (see below)
Expand Down
Loading