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
79 changes: 79 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
name: Bug report
description: Report incorrect or unsafe Kitout behavior
title: "[Bug]: "
body:
- type: markdown
attributes:
value: |
Thanks for reporting a problem. Remove secrets and private paths from all examples and logs.

- type: input
id: version
attributes:
label: Kitout version
description: Paste the output of `kitout version`.
placeholder: kitout 2.7.0, commit abc1234
validations:
required: true

- type: input
id: macos
attributes:
label: macOS and architecture
placeholder: macOS 26.0, Apple Silicon
validations:
required: true

- type: dropdown
id: installation
attributes:
label: Installation method
options:
- Homebrew
- GitHub release
- Built from source
validations:
required: true

- type: textarea
id: command
attributes:
label: Command
description: Include the exact command and flags you ran.
render: shell
validations:
required: true

- type: textarea
id: config
attributes:
label: Relevant redacted configuration
description: Include only the relevant YAML and replace private values.
render: yaml

- type: textarea
id: expected
attributes:
label: Expected behavior
validations:
required: true

- type: textarea
id: actual
attributes:
label: Actual behavior and output
description: Include redacted output and whether `--dry-run` produced the same problem.
validations:
required: true

- type: checkboxes
id: checks
attributes:
label: Checklist
options:
- label: I searched existing issues for this problem.
required: true
- label: I removed secrets and private information from this report.
required: true
- label: This is not a security vulnerability.
required: true
8 changes: 8 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
blank_issues_enabled: false
contact_links:
- name: Report a security vulnerability
url: https://github.com/vwall/kitout/security/advisories/new
about: Share vulnerability details privately with the maintainer.
- name: Read the documentation
url: https://vwall.github.io/kitout/
about: Review installation, configuration, resources, and first-run guidance.
42 changes: 42 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: Feature request
description: Propose a focused improvement to Kitout
title: "[Feature]: "
body:
- type: textarea
id: problem
attributes:
label: Problem
description: Describe the Mac setup problem or workflow gap.
validations:
required: true

- type: textarea
id: proposal
attributes:
label: Proposed behavior
description: Show the proposed command or YAML shape when relevant.
validations:
required: true

- type: textarea
id: safety
attributes:
label: Safety and idempotency
description: Explain what status, dry-run, apply, confirmation, and repeated runs should do.
validations:
required: true

- type: textarea
id: alternatives
attributes:
label: Alternatives considered

- type: checkboxes
id: scope
attributes:
label: Checklist
options:
- label: I searched existing issues for a similar request.
required: true
- label: This request does not require storing secrets in Kitout configuration.
required: true
22 changes: 22 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
version: 2

updates:
- package-ecosystem: gomod
directory: /
schedule:
interval: weekly
open-pull-requests-limit: 5
groups:
go-dependencies:
patterns:
- "*"

- package-ecosystem: github-actions
directory: /
schedule:
interval: weekly
open-pull-requests-limit: 5
groups:
github-actions:
patterns:
- "*"
21 changes: 21 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
## Summary

Describe the user-visible change and why it belongs in Kitout.

## Verification

- [ ] `make fmt-check`
- [ ] `make test`
- [ ] `make vet`
- [ ] `make release-check` when changing runtime, release, or macOS behavior

## Safety

- [ ] Status and dry-run remain read-only.
- [ ] Apply remains idempotent.
- [ ] Risky changes require explicit configuration and confirmation.
- [ ] No secrets or private machine details are included.

## Documentation

- [ ] CLI help, docs, and examples are updated when behavior or configuration changes.
42 changes: 42 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,42 @@
name: CI

on:
pull_request:
push:
branches:
- main

permissions:
contents: read

concurrency:
group: ci-${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

jobs:
verify:
name: Verify
runs-on: macos-latest
timeout-minutes: 15

steps:
- name: Check out repository
uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4

- name: Set up Go
uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5
with:
go-version-file: go.mod
cache: true

- name: Check formatting
run: make fmt-check

- name: Run tests
run: make test

- name: Run vet
run: make vet

- name: Run distribution smoke test
run: make smoke-distribution
8 changes: 4 additions & 4 deletions .github/workflows/pages.yml
Original file line number Diff line number Diff line change
Expand Up @@ -28,16 +28,16 @@ jobs:

steps:
- name: Check out repository
uses: actions/checkout@v4
uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4

- name: Configure GitHub Pages
uses: actions/configure-pages@v5
uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5

- name: Upload docs site
uses: actions/upload-pages-artifact@v3
uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v3
with:
path: docs

- name: Deploy GitHub Pages
id: deployment
uses: actions/deploy-pages@v4
uses: actions/deploy-pages@d6db90164ac5ed86f2b6aed7e0febac5b3c0c03e # v4
6 changes: 3 additions & 3 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@ jobs:

steps:
- name: Check out repository
uses: actions/checkout@v4
uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4
with:
fetch-depth: 0

- name: Set up Go
uses: actions/setup-go@v5
uses: actions/setup-go@40f1582b2485089dde7abd97c1529aa768e1baff # v5
with:
go-version-file: go.mod

Expand Down Expand Up @@ -120,7 +120,7 @@ jobs:
cat "dist/kitout_${VERSION}_checksums.txt"

- name: Upload workflow artifacts
uses: actions/upload-artifact@v4
uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4
with:
name: kitout-${{ steps.metadata.outputs.version }}-darwin
path: |
Expand Down
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
/bin/
/dist/
.gocache/
.DS_Store
.impeccable/
private-docs/
/tmp/
/AGENTS.md
Loading
Loading