-
-
Notifications
You must be signed in to change notification settings - Fork 0
Phase H: distribution — GoReleaser, install script, landing + docs site #11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 8 commits
Commits
Show all changes
13 commits
Select commit
Hold shift + click to select a range
75235f2
build(release): GoReleaser config + release workflow
nixrajput 00744ef
build(install): POSIX install script with checksum verification
nixrajput 2185b07
feat(web): Next.js app scaffold + Markdown docs pipeline
nixrajput 2b86255
feat(web): landing page + docs reader UI
nixrajput c086ad5
docs: Phase H install docs + provisioning checklist
nixrajput fb73579
build(ci): harden release workflow + add issue/PR templates
nixrajput bff30d1
feat(web): motion + Getting Started / Configuration docs
nixrajput 1132018
fix: apply CodeRabbit review fixes for Phase H
nixrajput c76c4f0
fix(install): fail closed on cosign verification, pin signer identity
nixrajput 84009a1
docs: update project status and formatting in README
nixrajput 96ae0c6
build: add web lint/format tooling + pre-push hook
nixrajput 2978738
feat: revamp landing page, docs UI, and SEO
nixrajput d56071e
fix: address PR review on web revamp
nixrajput File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| name: Bug report | ||
| description: Something siphon did wrong — a crash, wrong output, or a failed operation. | ||
| labels: ["bug"] | ||
| body: | ||
| - type: markdown | ||
| attributes: | ||
| value: | | ||
| Thanks for the report. Please include enough to reproduce — siphon shells | ||
| out to native dump/restore tools, so the exact command and engine matter. | ||
| - type: textarea | ||
| id: what-happened | ||
| attributes: | ||
| label: What happened | ||
| description: What you ran and what went wrong. Paste the command and the error. | ||
| placeholder: | | ||
| $ siphon backup prod | ||
| ✗ ... | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: expected | ||
| attributes: | ||
| label: What you expected | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: version | ||
| attributes: | ||
| label: siphon version | ||
| description: Output of `siphon --version`. | ||
| placeholder: "v1.0.0" | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: engine | ||
| attributes: | ||
| label: Database engine | ||
| options: | ||
| - PostgreSQL | ||
| - MySQL | ||
| - MariaDB | ||
| - Cross-engine (specify in details) | ||
| - Not engine-specific | ||
| validations: | ||
| required: true | ||
| - type: dropdown | ||
| id: os | ||
| attributes: | ||
| label: OS | ||
| options: [Linux, macOS, Windows] | ||
| validations: | ||
| required: true | ||
| - type: input | ||
| id: exit-code | ||
| attributes: | ||
| label: Exit code | ||
| description: siphon uses a POSIX exit-code taxonomy; the number helps classify the failure. | ||
| placeholder: "e.g. 1 (user), 70 (system), 65 (integrity)" | ||
| - type: textarea | ||
| id: details | ||
| attributes: | ||
| label: Anything else | ||
| description: Profile config (redact secrets), storage backend, logs, repro steps. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,8 @@ | ||
| blank_issues_enabled: false | ||
| contact_links: | ||
| - name: Question or discussion | ||
| url: https://github.com/nixrajput/siphon/discussions | ||
| about: For usage questions and ideas, start a discussion instead of an issue. | ||
| - name: Security vulnerability | ||
| url: https://github.com/nixrajput/siphon/security/policy | ||
| about: Please report security issues privately, not as a public issue. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| name: Feature request | ||
| description: Suggest a capability or improvement. | ||
| labels: ["enhancement"] | ||
| body: | ||
| - type: textarea | ||
| id: problem | ||
| attributes: | ||
| label: The problem | ||
| description: What are you trying to do that siphon makes hard or impossible today? | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: proposal | ||
| attributes: | ||
| label: Proposed solution | ||
| description: What you'd like siphon to do. A command sketch helps. | ||
| validations: | ||
| required: true | ||
| - type: textarea | ||
| id: alternatives | ||
| attributes: | ||
| label: Alternatives considered | ||
| - type: dropdown | ||
| id: area | ||
| attributes: | ||
| label: Area | ||
| options: | ||
| - Backup / restore | ||
| - Sync / CDC / cross-engine | ||
| - Storage backends | ||
| - Retention | ||
| - Secrets / auth / audit | ||
| - TUI | ||
| - Drivers (new engine) | ||
| - Other | ||
| validations: | ||
| required: true |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| ## What & why | ||
|
|
||
| <!-- What this changes and the reason. Link any issue: Closes #123. --> | ||
|
|
||
| ## How it was verified | ||
|
|
||
| <!-- Commands run and their outcome — evidence, not assertions. --> | ||
|
|
||
| - [ ] `make test` passes | ||
| - [ ] `make lint` passes (0 issues) | ||
| - [ ] `make test-integration` (if the change touches a live DB / storage path) | ||
| - [ ] Docs updated (README / `docs/*.md` / CHANGELOG) for any user-facing change | ||
| - [ ] `web/` builds (`npm run build`) — only if the site changed | ||
|
|
||
| ## Notes for reviewers | ||
|
|
||
| <!-- Anything non-obvious: a deliberate scope decision, a deferred follow-up, | ||
| a tradeoff, or a place you'd especially like eyes. --> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,90 @@ | ||
| name: Release | ||
|
|
||
| # Auto-releases when a version tag (vX.Y.Z) is pushed. GoReleaser builds the | ||
| # cross-platform binaries, SHA-256 checksums, and cosign-keyless signatures, | ||
| # publishes a GitHub Release, and — when the tap repos + tokens exist — pushes | ||
| # the Homebrew formula and Scoop manifest. | ||
| # | ||
| # A validation gate (test + lint + config check) runs first, so a broken tag | ||
| # never publishes. workflow_dispatch runs a snapshot dry-run (no publish) to | ||
| # rehearse a release without tagging. | ||
| on: | ||
| push: | ||
| tags: | ||
| - "v*" | ||
| workflow_dispatch: {} | ||
|
|
||
| permissions: | ||
| contents: read | ||
|
|
||
| jobs: | ||
| # Gate: the same checks CI runs, plus goreleaser config validation. The | ||
| # release job depends on this, so a failing test/lint aborts before publish. | ||
| validate: | ||
| name: Validate | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - uses: actions/checkout@v6 | ||
| with: | ||
| fetch-depth: 0 | ||
| persist-credentials: false # don't leave the token in .git/config | ||
| - uses: actions/setup-go@v6 | ||
| with: | ||
| go-version-file: go.mod # reproducible: pin the toolchain to go.mod | ||
| cache: true | ||
| - name: Test | ||
| run: go test ./... github.com/nixrajput/siphon/internal/driver/_mysqlcommon | ||
| - name: Lint | ||
| uses: golangci/golangci-lint-action@v6 | ||
| - name: GoReleaser check | ||
| uses: goreleaser/goreleaser-action@v6 | ||
|
nixrajput marked this conversation as resolved.
|
||
| with: | ||
| version: "~> v2" | ||
| args: check | ||
|
|
||
| release: | ||
| name: Release | ||
| needs: validate | ||
| runs-on: ubuntu-latest | ||
| permissions: | ||
| contents: write # create the GitHub Release | ||
| id-token: write # cosign keyless signing via GitHub OIDC | ||
| steps: | ||
| - uses: actions/checkout@v6 | ||
| with: | ||
| fetch-depth: 0 | ||
| persist-credentials: false # don't leave the token in .git/config # GoReleaser needs full history + tags for the changelog | ||
|
|
||
| - uses: actions/setup-go@v6 | ||
| with: | ||
| go-version-file: go.mod # reproducible: pin the toolchain to go.mod | ||
| cache: true | ||
|
|
||
| - name: Install cosign | ||
| uses: sigstore/cosign-installer@v3 | ||
|
|
||
| # On a tag push: full release. On manual dispatch: snapshot dry-run that | ||
| # builds everything locally and publishes nothing (rehearsal). | ||
| - name: Set release args | ||
| id: args | ||
| run: | | ||
| if [ "${{ github.ref_type }}" = "tag" ]; then | ||
| echo "args=release --clean" >> "$GITHUB_OUTPUT" | ||
| else | ||
| echo "args=release --clean --snapshot" >> "$GITHUB_OUTPUT" | ||
| fi | ||
|
|
||
| - name: Run GoReleaser | ||
| uses: goreleaser/goreleaser-action@v6 | ||
| with: | ||
| version: "~> v2" | ||
| args: ${{ steps.args.outputs.args }} | ||
| env: | ||
| GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | ||
| # Tap-push tokens. These secrets may be unset on early releases; a | ||
| # GitHub Actions secret expression yields "" when absent, so the | ||
| # GoReleaser token template still resolves and skip_upload: auto | ||
| # quietly skips the brew/scoop push instead of erroring. Provision | ||
| # these (PATs with repo scope on the tap repos) to enable publishing. | ||
| HOMEBREW_TAP_GITHUB_TOKEN: ${{ secrets.HOMEBREW_TAP_GITHUB_TOKEN }} | ||
| SCOOP_TAP_GITHUB_TOKEN: ${{ secrets.SCOOP_TAP_GITHUB_TOKEN }} | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,109 @@ | ||
| # GoReleaser v2 configuration — https://goreleaser.com | ||
| # Drives the release: cross-platform binaries, archives, SHA-256 checksums, | ||
| # cosign-keyless signatures, a GitHub Release, and (when the tap repos + | ||
| # token exist) a Homebrew formula and Scoop manifest. | ||
| # | ||
| # Run locally (no publish): goreleaser release --snapshot --clean | ||
| # Validate config: goreleaser check | ||
| version: 2 | ||
|
|
||
| project_name: siphon | ||
|
|
||
| # No `go mod tidy` before-hook: the release path stays read-only so the | ||
| # published binary is built from exactly the committed dependency graph at the | ||
| # tagged revision (CI enforces tidiness separately). | ||
|
|
||
| builds: | ||
| - id: siphon | ||
| main: ./cmd/siphon | ||
| binary: siphon | ||
| env: | ||
| - CGO_ENABLED=0 | ||
| goos: [linux, darwin, windows] | ||
| goarch: [amd64, arm64] | ||
| # Match the version symbol the Makefile already injects, so a released | ||
| # binary's `siphon --version` reports the tag (not "0.0.1-dev"). | ||
| ldflags: | ||
| - -s -w | ||
| - -X github.com/nixrajput/siphon/internal/cli.Version={{.Version}} | ||
|
|
||
| archives: | ||
| - id: siphon | ||
| formats: [tar.gz] | ||
| # Windows users expect .zip. | ||
| format_overrides: | ||
| - goos: windows | ||
| formats: [zip] | ||
| name_template: >- | ||
| {{ .ProjectName }}_{{ .Version }}_{{ .Os }}_{{ .Arch }} | ||
| files: | ||
| - LICENSE | ||
| - README.md | ||
|
|
||
| checksum: | ||
| name_template: "checksums.txt" | ||
| algorithm: sha256 | ||
|
|
||
| # Cosign keyless signing of the checksums file. The release workflow grants | ||
| # id-token: write so cosign authenticates via GitHub's OIDC — no key to manage. | ||
| # Verify with: cosign verify-blob --certificate checksums.txt.pem \ | ||
| # --signature checksums.txt.sig --certificate-identity-regexp ... checksums.txt | ||
| signs: | ||
| - cmd: cosign | ||
| artifacts: checksum | ||
| output: true | ||
| certificate: "${artifact}.pem" | ||
| args: | ||
| - sign-blob | ||
| - "--output-certificate=${certificate}" | ||
| - "--output-signature=${signature}" | ||
| - "${artifact}" | ||
| - "--yes" | ||
|
|
||
| changelog: | ||
| use: github | ||
| sort: asc | ||
| filters: | ||
| exclude: | ||
| - "^docs:" | ||
| - "^test:" | ||
| - "^chore:" | ||
| - "Merge pull request" | ||
|
|
||
| release: | ||
| github: | ||
| owner: nixrajput | ||
| name: siphon | ||
| prerelease: auto # tags like v1.0.0-rc1 → marked prerelease automatically | ||
|
|
||
| # Homebrew tap. Publishes to a SEPARATE repo (nixrajput/homebrew-siphon) using | ||
| # a PAT in HOMEBREW_TAP_GITHUB_TOKEN. skip_upload: auto means snapshots and | ||
| # prereleases do NOT push the formula, so the core release succeeds even before | ||
| # the tap repo / token exist — light up brew on a later stable release. | ||
| brews: | ||
| - name: siphon | ||
| repository: | ||
| owner: nixrajput | ||
| name: homebrew-siphon | ||
| token: "{{ .Env.HOMEBREW_TAP_GITHUB_TOKEN }}" | ||
| homepage: "https://github.com/nixrajput/siphon" | ||
| description: "Sync any database, anywhere — backup, restore, and sync across engines." | ||
| license: "MIT" | ||
| skip_upload: auto | ||
| install: | | ||
| bin.install "siphon" | ||
| test: | | ||
| system "#{bin}/siphon", "--version" | ||
|
|
||
| # Scoop bucket (Windows). Publishes to nixrajput/scoop-siphon via | ||
| # SCOOP_TAP_GITHUB_TOKEN; same skip_upload: auto tolerance as brew. | ||
| scoops: | ||
| - name: siphon | ||
| repository: | ||
| owner: nixrajput | ||
| name: scoop-siphon | ||
| token: "{{ .Env.SCOOP_TAP_GITHUB_TOKEN }}" | ||
| homepage: "https://github.com/nixrajput/siphon" | ||
| description: "Sync any database, anywhere — backup, restore, and sync across engines." | ||
| license: "MIT" | ||
| skip_upload: auto |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.