Merge pull request #23 from kralicky/ci

Add simple test & binary release CI

.github/workflows/ci.yaml

@@ -0,0 +1,38 @@
+name: CI
+
+on:
+  pull_request:
+    paths-ignore:
+    - 'docs/**'
+    - '*.md'
+    - '.gitignore'
+  push:
+    branches:
+    - main
+    paths-ignore:
+    - 'docs/**'
+    - '*.md'
+    - '.gitignore'
+
+permissions:
+  contents: read
+
+jobs:
+  test-protols:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Go
+      uses: actions/setup-go@v5
+      with:
+        go-version: 1.22
+    - name: Test
+      run: go test -v -timeout 30s -coverprofile=cover.out -covermode=atomic -coverpkg=./... -race ./...
+    - name: Upload coverage
+      uses: codecov/[email protected]
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        file: ./cover.out
+        flags: unittests
+        verbose: true
+

.github/workflows/release.yaml

@@ -0,0 +1,29 @@
+name : Release
+
+on:
+  push:
+    tags:
+      - '*'
+
+permissions:
+  contents: write
+
+jobs:
+  goreleaser:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - run: git fetch --force --tags
+      - uses: actions/setup-go@v5
+        with:
+          go-version: 1.22
+          cache : false #  prevents cache poisoning for release artifacts through go mod cache
+      - uses: goreleaser/goreleaser-action@v5
+        with:
+          distribution: goreleaser
+          version: latest
+          args: release --clean
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -3,3 +3,4 @@
 go.work
 go.work.sum
 editors/vscode/*.vsix
+dist

.goreleaser.yaml

@@ -0,0 +1,42 @@
+# This is an example .goreleaser.yml file with some sensible defaults.
+# Make sure to check the documentation at https://goreleaser.com
+before:
+  hooks:
+    # You may remove this if you don't use go modules.
+    - go mod tidy
+builds:
+    - id: protols
+      main: ./cmd/protols
+      goos:
+        - linux
+      goarch:
+        - amd64
+      binary: protols
+      ldflags:
+        - -extldflags "-static"
+        - -s
+        - -w
+        - -X github.com/kralicky/protols/pkg/version.Version={{.Version}} 
+        - -X github.com/kralicky/protols/pkg/version.Commit={{.Commit}}
+      flags:
+        - -trimpath
+      env:
+        - CGO_ENABLED=0
+
+archives:
+    - id: protols
+      builds:
+        - protols
+      name_template: '{{ .Binary }}_{{ .Version }}_{{ .Os }}_{{ .Arch }}{{ if .Arm }}v{{ .Arm }}{{ end }}{{ if .Mips }}_{{ .Mips }}{{ end }}'
+checksum:
+  name_template: 'checksums.txt'
+release:
+  prerelease : auto
+snapshot:
+  name_template: "{{ incpatch .Version }}-next"
+changelog:
+  sort: asc
+  filters:
+    exclude:
+      - '^docs:'
+      - '^test:'

README.md

@@ -1,5 +1,9 @@
 # Protobuf Language Server
 
+![Release](https://img.shields.io/github/v/release/kralicky/protols)
+[![CI](https://github.com/kralicky/protols/actions/workflows/ci.yaml/badge.svg)](https://github.com/kralicky/protols/actions/workflows/test.yaml)
+[![License](https://img.shields.io/github/license/kralicky/protols)](./LICENSE)
+
 # Coming Soon™
 
 A language server implementation for Protocol Buffers. Still in development.

pkg/protols/commands/serve.go

@@ -9,6 +9,7 @@ import (
 	"sync"
 
 	"github.com/kralicky/protols/pkg/lsprpc"
+	"github.com/kralicky/protols/pkg/version"
 	"github.com/kralicky/tools-lite/pkg/event"
 	"github.com/kralicky/tools-lite/pkg/event/core"
 	"github.com/kralicky/tools-lite/pkg/event/keys"
@@ -24,6 +25,7 @@ func BuildServeCmd() *cobra.Command {
 		Use:   "serve",
 		Short: "Start the language server",
 		RunE: func(cmd *cobra.Command, args []string) error {
+			cmd.Printf("Starting protols %s\n", version.FriendlyVersion())
 			slog.SetDefault(slog.New(slog.NewTextHandler(cmd.OutOrStderr(), &slog.HandlerOptions{
 				AddSource: true,
 				Level:     slog.LevelDebug,

pkg/protols/root.go

@@ -4,14 +4,16 @@ import (
 	"os"
 
 	"github.com/kralicky/protols/pkg/protols/commands"
+	"github.com/kralicky/protols/pkg/version"
 	"github.com/spf13/cobra"
 )
 
 // rootCmd represents the base command when called without any subcommands
 func BuildRootCmd() *cobra.Command {
 	rootCmd := &cobra.Command{
-		Use:   "protols",
-		Short: "Protobuf Language Server",
+		Use:     "protols",
+		Short:   "Protobuf Language Server",
+		Version: version.FriendlyVersion(),
 	}
 
 	rootCmd.AddCommand(commands.BuildFmtCmd())

pkg/version/version.go

@@ -0,0 +1,13 @@
+package version
+
+import "fmt"
+
+var (
+	Version   = "v0.0.0-dev"
+	GitCommit = "HEAD"
+)
+
+// FriendlyVersion returns the version to be displayed on running --version
+func FriendlyVersion() string {
+	return fmt.Sprintf("%s (%s)", Version, GitCommit)
+}