summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPaul Buetow <paul@buetow.org>2025-10-31 20:13:32 +0200
committerPaul Buetow <paul@buetow.org>2025-10-31 20:13:32 +0200
commit11eea6a82cbfdde40ec1457c6ea080da4da6b7dc (patch)
tree8026068f6a3beb3ee02c45f06f4487f4b89caaf1 /doc
parent5c3e0b5cf99d028c4f06be7a825388b296e37a22 (diff)
feat: implement amp AI tool support and replace Taskfile with Magev0.10.0
- Add amp as default AI tool for release notes and showcase generation - Fallback chain: amp → hexai → claude → aichat - Replace Taskfile.yaml with magefile.go for build automation - Update all documentation (README.md, AGENTS.md, doc/development.md) - Update version to 0.10.0 Amp-Thread-ID: https://ampcode.com/threads/T-735ba1e2-0255-4b43-8ed1-6c0d2f78301b Co-authored-by: Amp <amp@ampcode.com>
Diffstat (limited to 'doc')
-rw-r--r--doc/development.md38
1 files changed, 18 insertions, 20 deletions
diff --git a/doc/development.md b/doc/development.md
index b22fbd4..75274f0 100644
--- a/doc/development.md
+++ b/doc/development.md
@@ -18,8 +18,7 @@ This guide is for contributors who want to help develop GitSyncer.
- Go 1.21 or later
- Git
-- Make (optional, for Makefile)
-- Task (optional, for Taskfile)
+- Mage (optional, for magefile.go)
### Clone the Repository
@@ -46,12 +45,8 @@ go mod verify
### Install Development Tools
```bash
-# Install Task runner (optional)
-# macOS
-brew install go-task
-
-# Linux
-sh -c "$(curl --location https://taskfile.dev/install.sh)" -- -d -b ~/.local/bin
+# Install Mage (build tool)
+go install github.com/magefile/mage@latest
# Install golangci-lint for linting
go install github.com/golangci/golangci-lint/cmd/golangci-lint@latest
@@ -91,26 +86,29 @@ gitsyncer/
├── go.sum # Go module checksums
├── LICENSE # BSD 2-Clause License
├── README.md # Project README
-├── CLAUDE.md # AI assistant hints
-└── Taskfile.yaml # Task automation
+├── AGENTS.md # AI assistant hints
+└── magefile.go # Mage build automation
```
## Building
-### Using Task (Recommended)
+### Using Mage (Recommended)
```bash
+# List available targets
+mage -l
+
# Build for current platform
-task build
+mage build
# Build for all platforms
-task build-all
+mage buildAll
# Run directly
-task run
+mage run
-# Run with arguments
-task run -- --version
+# Show version
+mage version
```
### Using Go Directly
@@ -202,7 +200,7 @@ Follow standard Go conventions:
1. **Formatting**: Use `gofmt` or `goimports`
```bash
# Format all files
- task fmt
+ mage fmt
# or
gofmt -w .
```
@@ -364,7 +362,7 @@ test: add integration tests for branch filtering
2. **Format code**:
```bash
- task fmt
+ mage fmt
```
3. **Update documentation**:
@@ -372,7 +370,7 @@ test: add integration tests for branch filtering
- Update README if adding user-facing features
- Add examples to `doc/examples.md`
-4. **Update CLAUDE.md** if adding development commands
+4. **Update AGENTS.md** if adding development commands
### Pull Request Process
@@ -442,6 +440,6 @@ GITSYNCER_DEBUG=1 gitsyncer --sync test-repo
```
4. Build releases:
```bash
- task build-all
+ mage buildAll
```
5. Create GitHub/Codeberg release with binaries \ No newline at end of file