scaffold: Go module and shared tooling baseline

Initialise github.com/apptly-oss/bubblespice with the Go module, a
root doc.go, and the tooling shared with other apptly-oss repos:

- Makefile driving build/test/coverage, with internal/build/* helper
  scripts (get_version, gen_index, gen_mk, fix_whitespace, coverage
  merge, languagetool config).
- Lint configs: .golangci.yml, internal/build/revive.toml,
  .deepsource.toml.
- GitHub Actions workflows: build, test, race, codecov, renovate.
- Editor and spell-check: .editorconfig, .vscode/, cspell dictionaries
  (top-level and internal/build).
- Project files: README.md, AGENTS.md, LICENCE.txt, renovate.json,
  .gitignore.

Functional packages land in follow-up commits.

Signed-off-by: Alejandro Mery <amery@apptly.co>

Author: amery

.deepsource.toml

@@ -0,0 +1,26 @@
+version = 1
+
+# Exclude specific issues globally
+exclude_patterns = [
+  "**/*.test",
+  ".tmp/**",
+]
+
+# Skip specific DeepSource issues
+[[issues]]
+# Skip "local is undefined in POSIX sh"
+id = "SH-1091"
+paths = ["**/*.sh"]
+
+[[analyzers]]
+name = "shell"
+
+  [analyzers.meta]
+  # Use sh dialect but DeepSource should be smart enough to handle common extensions
+  dialect = "sh"
+
+[[analyzers]]
+name = "go"
+
+  [analyzers.meta]
+  import_root = "github.com/apptly-oss/bubblespice"

.editorconfig

@@ -0,0 +1,22 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_style = tab
+indent_size = 8
+insert_final_newline = true
+trim_trailing_whitespace = true
+max_line_length = 80
+
+[*.go]
+indent_size = 4
+
+[*.{json,yaml,yml,md}]
+indent_style = space
+indent_size = 2
+
+[{go.mod,go.sum}]
+max_line_length = off

.github/workflows/build.yml

@@ -0,0 +1,28 @@
+name: Build
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches-ignore:
+      - '**-wip'
+  pull_request:
+
+jobs:
+  make:
+    runs-on: ubuntu-latest
+    # Pull requests from the same repository won't trigger this checks as they were already triggered by the push
+    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
+    strategy:
+      matrix:
+        go: [ '1.24', '1.25', '1.26' ]
+    steps:
+    - uses: actions/checkout@v6
+    - uses: actions/setup-go@v6
+      with:
+        go-version: ${{ matrix.go }}
+        cache: true
+        cache-dependency-path: '**/go.sum'
+    - name: Build
+      run: make

.github/workflows/codecov.yml

@@ -0,0 +1,36 @@
+name: Codecov
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches-ignore:
+      - '**-wip'
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    # Pull requests from the same repository won't trigger this checks as they were already triggered by the push
+    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
+    steps:
+    - uses: actions/checkout@v6
+
+    - name: Set up Go
+      uses: actions/setup-go@v6
+      with:
+        go-version: '1.26'
+        cache: true
+        cache-dependency-path: '**/go.sum'
+
+    - name: Run tests with coverage
+      run: make clean-coverage codecov
+
+    - name: Upload coverage to Codecov
+      run: |
+        # The codecov.sh script was generated by make_codecov.sh
+        # It uploads each module's coverage file with the appropriate flag
+        ./.tmp/coverage/codecov.sh
+      env:
+        CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.github/workflows/race.yml

@@ -0,0 +1,28 @@
+name: Race Detection
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches-ignore:
+      - '**-wip'
+  pull_request:
+
+jobs:
+  race:
+    runs-on: ubuntu-latest
+    # Pull requests from the same repository won't trigger this checks as they were already triggered by the push
+    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
+    steps:
+    - uses: actions/checkout@v6
+
+    - name: Set up Go
+      uses: actions/setup-go@v6
+      with:
+        go-version: '1.26'
+        cache: true
+        cache-dependency-path: '**/go.sum'
+
+    - name: Run tests with race detection
+      run: make race GOTEST_FLAGS="-v"

.github/workflows/renovate.yml

@@ -0,0 +1,26 @@
+name: renovate-config-validator
+
+permissions:
+  contents: read
+
+on:
+  push:
+    paths:
+      - 'renovate.json'
+  pull_request:
+    paths:
+      - 'renovate.json'
+
+jobs:
+  renovate-config-validator:
+    runs-on: ubuntu-latest
+    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
+
+    steps:
+    - uses: actions/checkout@v6
+    - uses: actions/setup-node@v6
+      with:
+        node-version: '22'
+
+    - name: Run renovate-config-validator
+      run: npx --yes --package renovate -- renovate-config-validator --strict

.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: Test
+
+permissions:
+  contents: read
+
+on:
+  push:
+    branches-ignore:
+      - '**-wip'
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    # Pull requests from the same repository won't trigger this checks as they were already triggered by the push
+    if: (github.event_name == 'push' || github.event.pull_request.head.repo.full_name != github.repository)
+    strategy:
+      matrix:
+        go-version: ['1.24', '1.25', '1.26']
+    steps:
+    - uses: actions/checkout@v6
+
+    - name: Set up Go ${{ matrix.go-version }}
+      uses: actions/setup-go@v6
+      with:
+        go-version: ${{ matrix.go-version }}
+        cache: true
+        cache-dependency-path: '**/go.sum'
+
+    - name: Run tests
+      run: make test GOTEST_FLAGS="-v"

.gitignore

@@ -0,0 +1,7 @@
+# Coverage files (legacy location - now in .tmp/coverage/)
+coverage.out
+coverage.html
+.coverage/
+# Build and temporary files
+.tmp
+*.test

.golangci.yml

@@ -0,0 +1,76 @@
+version: "2"
+run:
+  allow-parallel-runners: true
+  timeout: 5m
+  modules-download-mode: readonly
+linters:
+  default: none
+  enable:
+    - copyloopvar
+    - dupl
+    - errcheck
+    - goconst
+    - gocyclo
+    - govet
+    - ineffassign
+    - lll
+    - misspell
+    - nakedret
+    - prealloc
+    - revive
+    - staticcheck
+    - unconvert
+    - unparam
+    - unused
+  settings:
+    govet:
+      enable:
+        - fieldalignment
+    revive:
+      rules:
+        - name: blank-imports
+        - name: context-as-argument
+        - name: context-keys-type
+        - name: dot-imports
+        - name: error-return
+        - name: error-strings
+        - name: error-naming
+        - name: exported
+        - name: increment-decrement
+        - name: var-naming
+        - name: var-declaration
+        - name: package-comments
+        - name: range
+        - name: receiver-naming
+        - name: time-naming
+        - name: unexported-return
+        - name: indent-error-flow
+        - name: errorf
+        - name: empty-block
+        - name: superfluous-else
+        - name: unused-parameter
+        - name: unreachable-code
+        - name: redefines-builtin-id
+        - name: bool-literal-in-expr
+        - name: constant-logical-expr
+  exclusions:
+    generated: lax
+    presets:
+      - comments
+      - common-false-positives
+      - legacy
+      - std-error-handling
+    paths:
+      - third_party$
+      - builtin$
+      - examples$
+formatters:
+  enable:
+    - gofmt
+    - goimports
+  exclusions:
+    generated: lax
+    paths:
+      - third_party$
+      - builtin$
+      - examples$

.vscode/cspell.json

@@ -0,0 +1 @@
+../internal/build/cspell.json