Merge remote-tracking branch 'origin/main' into feat/sub-issues

Author: LuluBeatson

.github/workflows/docs-check.yml

@@ -0,0 +1,47 @@
+name: Documentation Check
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+permissions:
+  contents: read
+
+jobs:
+  docs-check:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v4
+
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version-file: 'go.mod'
+
+    - name: Build docs generator
+      run: go build -o github-mcp-server ./cmd/github-mcp-server
+
+    - name: Generate documentation
+      run: ./github-mcp-server generate-docs
+
+    - name: Check for documentation changes
+      run: |
+        if ! git diff --exit-code README.md; then
+          echo "❌ Documentation is out of date!"
+          echo ""
+          echo "The generated documentation differs from what's committed."
+          echo "Please run the following command to update the documentation:"
+          echo ""
+          echo "  go run ./cmd/github-mcp-server generate-docs"
+          echo ""
+          echo "Then commit the changes."
+          echo ""
+          echo "Changes detected:"
+          git diff README.md
+          exit 1
+        else
+          echo "✅ Documentation is up to date!"
+        fi

.github/workflows/go.yml

@@ -1,4 +1,4 @@
-name: Unit Tests
+name: Build and Test Go Project
 on: [push, pull_request]
 
 permissions:
@@ -26,7 +26,7 @@ jobs:
         run: go mod download
 
       - name: Run unit tests
-        run: go test -race ./...
+        run: script/test
 
       - name: Build
         run: go build -v ./cmd/github-mcp-server

.github/workflows/lint.yaml

@@ -0,0 +1,23 @@
+name: golangci-lint
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+permissions:
+  contents: read
+
+jobs:
+  golangci:
+    name: lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: stable
+      - name: golangci-lint
+        uses: golangci/golangci-lint-action@v8
+        with:
+          version: v2.1

.github/workflows/lint.yml

@@ -11,3 +11,7 @@ __debug_bin*
 
 # Go
 vendor
+bin/
+
+# macOS
+.DS_Store

.gitignore

@@ -1,47 +1,37 @@
-# https://golangci-lint.run/usage/configuration
 version: "2"
-
 run:
-  timeout: 5m
-  tests: true
   concurrency: 4
-
+  tests: true
 linters:
   enable:
-    - govet
-    - errcheck
-    - staticcheck
-    - revive
-    - ineffassign
-    - unused
-    - misspell
-    - nakedret
     - bodyclose
     - gocritic
-    - makezero
     - gosec
+    - makezero
+    - misspell
+    - nakedret
+    - revive
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
   settings:
     staticcheck:
       checks:
-        - all
-        - '-QF1008' # Allow embedded structs to be referenced by field
-        - '-ST1000' # Do not require package comments
-    revive:
-      rules:
-        - name: exported
-          disabled: true
-        - name: exported
-          disabled: true
-        - name: package-comments
-          disabled: true
-
+        - "all"
+        - -QF1008
+        - -ST1000
 formatters:
-  enable:
-    - gofmt
-    - goimports
-
-output:
-  formats:
-    text:
-      print-linter-name: true
-      print-issued-lines: true
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

.golangci.yml

@@ -14,20 +14,21 @@ Please note that this project is released with a [Contributor Code of Conduct](C
 
 These are one time installations required to be able to test your changes locally as part of the pull request (PR) submission process.
 
-1. install Go [through download](https://go.dev/doc/install) | [through Homebrew](https://formulae.brew.sh/formula/go)
-1. [install golangci-lint v2](https://golangci-lint.run/welcome/install/#local-installation)
+1. Install Go [through download](https://go.dev/doc/install) | [through Homebrew](https://formulae.brew.sh/formula/go)
+2. [Install golangci-lint v2](https://golangci-lint.run/welcome/install/#local-installation)
 
 ## Submitting a pull request
 
-> **Important**: Please open your pull request against the `next` branch, not `main`. The `next` branch is where we integrate new features and changes before they are merged to `main`.
-
 1. [Fork][fork] and clone the repository
-1. Make sure the tests pass on your machine: `go test -v ./...`
-1. Make sure linter passes on your machine: `golangci-lint run`
-1. Create a new branch: `git checkout -b my-branch-name`
-1. Make your change, add tests, and make sure the tests and linter still pass
-1. Push to your fork and [submit a pull request][pr] targeting the `next` branch
-1. Pat yourself on the back and wait for your pull request to be reviewed and merged.
+2. Make sure the tests pass on your machine: `go test -v ./...`
+3. Make sure linter passes on your machine: `golangci-lint run`
+4. Create a new branch: `git checkout -b my-branch-name`
+5. Add your changes and tests, and make sure the Action workflows still pass
+    - Run linter: `script/lint`
+    - Update snapshots and run tests: `UPDATE_TOOLSNAPS=true go test ./...`
+    - Update readme documentation: `script/generate-docs`
+6. Push to your fork and [submit a pull request][pr] targeting the `main` branch
+7. Pat yourself on the back and wait for your pull request to be reviewed and merged.
 
 Here are a few things you can do that will increase the likelihood of your pull request being accepted: