Merge pull request #2 from rollkit/sevey/ci

feat(ci): add baseline CI

.github/auto_request_review.yml

@@ -0,0 +1,21 @@
+reviewers:
+  defaults:
+    - rollkit
+  groups:
+    rollkit:
+      - Manav-Aggarwal
+      - tzdybal
+      - gupadhyaya
+      - tuxcanfly
+      - MSevey
+files:
+  "**":
+    - rollkit
+  ".github/**":
+    - MSevey
+    - rollkit
+options:
+  ignore_draft: true
+  ignored_keywords:
+    - WIP
+  number_of_reviewers: 3

.github/dependabot.yml

@@ -0,0 +1,16 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: daily
+    open-pull-requests-limit: 10
+    labels:
+      - T:dependencies
+  - package-ecosystem: gomod
+    directory: "/"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 10
+    labels:
+      - T:dependencies

.github/pull_request_template.md

@@ -0,0 +1,18 @@
+<!--
+Please read and fill out this form before submitting your PR.
+
+Please make sure you have reviewed our contributors guide before submitting your
+first PR.
+
+NOTE: PR titles should follow semantic commits: https://www.conventionalcommits.org/en/v1.0.0/
+-->
+
+## Overview
+
+<!-- 
+Please provide an explanation of the PR, including the appropriate context,
+background, goal, and rationale. If there is an issue with this information,
+please provide a tl;dr and link the issue. 
+
+Ex: Closes #<issue number>
+-->

.github/workflows/ci_release.yml

@@ -0,0 +1,74 @@
+name: CI and Release
+on:
+  push:
+    branches:
+      - main
+    # Trigger on version tags
+    tags:
+      - "v*"
+  pull_request:
+  merge_group:
+  workflow_dispatch:
+    # Inputs the workflow accepts.
+    inputs:
+      version:
+        # Friendly description to be shown in the UI instead of 'name'
+        description: "Semver type of new version (major / minor / patch)"
+        # Input has to be provided for the workflow to run
+        required: true
+        type: choice
+        options:
+          - patch
+          - minor
+          - major
+
+jobs:
+  setup:
+    runs-on: ubuntu-latest
+    env:
+      # use consistent go version throughout pipeline here
+      GO_VERSION: "1.21"
+    outputs:
+      go-version: ${{ steps.set-vars.outputs.go-version }}
+    steps:
+      - name: Set go version
+        id: set-vars
+        run: echo "go-version=${{env.GO_VERSION}}" >> "$GITHUB_OUTPUT"
+
+  lint:
+    needs: [setup]
+    uses: ./.github/workflows/lint.yml
+    with:
+      go-version: ${{ needs.setup.outputs.go-version }}
+
+  test:
+    needs: [setup]
+    uses: ./.github/workflows/test.yml
+    with:
+      go-version: ${{ needs.setup.outputs.go-version }}
+
+  # branch_name trims ref/heads/ from github.ref to access a clean branch name
+  branch_name:
+    runs-on: ubuntu-latest
+    outputs:
+      branch: ${{ steps.trim_ref.outputs.branch }}
+    steps:
+      - name: Trim branch name
+        id: trim_ref
+        run: |
+          echo "branch=$(${${{ github.ref }}:11})" >> $GITHUB_OUTPUT
+
+  # Make a release if this is a manually trigger job, i.e. workflow_dispatch
+  release-dispatch:
+    needs: [lint, test, branch_name]
+    runs-on: ubuntu-latest
+    if: ${{ github.event_name == 'workflow_dispatch' }}
+    permissions: "write-all"
+    steps:
+      - uses: actions/checkout@v4
+      - name: Version Release
+        uses: rollkit/.github/.github/actions/[email protected]
+        with:
+          github-token: ${{secrets.GITHUB_TOKEN}}
+          version-bump: ${{inputs.version}}
+          release-branch: ${{needs.branch_name.outputs.branch}}

.github/workflows/housekeeping.yml

@@ -0,0 +1,39 @@
+name: Housekeeping
+
+on:
+  issues:
+    types: [opened]
+  pull_request_target:
+    types: [opened, ready_for_review]
+
+jobs:
+  auto-add-reviewer:
+    name: Auto add reviewer to PR
+    if: github.event.pull_request
+    uses: rollkit/.github/.github/workflows/[email protected]
+    secrets: inherit
+    permissions:
+      issues: write
+      pull-requests: write
+    with:
+      run-auto-request-review: true
+
+  auto-add-assignee:
+    # ignore dependabot PRs
+    if: ${{ github.event.pull_request && github.actor != 'dependabot[bot]' }}
+    name: Assign issue and PR to creator
+    runs-on: ubuntu-latest
+    permissions:
+      issues: write
+      pull-requests: write
+    steps:
+      - name: Set pull_request url and creator login
+        # yamllint disable rule:line-length
+        run: |
+          echo "PR=${{ github.event.pull_request.html_url }}" >> $GITHUB_ENV
+          echo "CREATOR=${{ github.event.pull_request.user.login }}" >> $GITHUB_ENV
+        # yamllint enable rule:line-length
+      - name: Assign PR to creator
+        run: gh pr edit ${{ env.PR }} --add-assignee ${{ env.CREATOR }}
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/lint.yml

@@ -0,0 +1,48 @@
+# lint runs all linters in this repository
+# This workflow is triggered by ci_release.yml workflow
+name: lint
+on:
+  workflow_call:
+    inputs:
+      go-version:
+        description: "Go version to use"
+        type: string
+        required: true
+
+jobs:
+  golangci-lint:
+    name: golangci-lint
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: ${{ inputs.go-version }}
+        # This steps sets the GIT_DIFF environment variable to true
+        # if files defined in PATTERS changed
+      - uses: technote-space/[email protected]
+        with:
+          # This job will pass without running if go.mod, go.sum, and *.go
+          # wasn't modified.
+          PATTERNS: |
+            **/**.go
+            go.mod
+            go.sum
+      - uses: golangci/[email protected]
+        with:
+          version: latest
+          args: --timeout 10m
+          github-token: ${{ secrets.github_token }}
+        if: env.GIT_DIFF
+
+  yamllint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: rollkit/.github/.github/actions/[email protected]
+
+  markdown-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: rollkit/.github/.github/actions/[email protected]

.github/workflows/semantic-pull-request.yml

@@ -0,0 +1,20 @@
+name: Semantic Pull Request
+
+on:
+  pull_request_target:
+    types:
+      - opened
+      - edited
+      - synchronize
+
+permissions:
+  pull-requests: read
+
+jobs:
+  main:
+    name: conventional-commit-pr-title
+    runs-on: ubuntu-latest
+    steps:
+      - uses: amannn/action-semantic-pull-request@v5
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/test.yml

@@ -0,0 +1,40 @@
+# Tests / Code Coverage workflow
+# This workflow is triggered by ci_release.yml workflow
+name: Tests / Code Coverage
+on:
+  workflow_call:
+    inputs:
+      go-version:
+        description: "Go version to use"
+        type: string
+        required: true
+
+jobs:
+  go_mod_tidy_check:
+    name: Go Mod Tidy Check
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-go@v5
+        with:
+          go-version: ${{ inputs.go-version }}
+      - run: go mod tidy
+      - name: check for diff
+        run: git diff --exit-code
+
+  unit_test:
+    name: Run Unit Tests
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: set up go
+        uses: actions/setup-go@v5
+        with:
+          go-version: ${{ inputs.go-version }}
+      - name: Run unit test
+        run: make test
+      # - name: upload coverage report
+      #   uses: codecov/[email protected]
+      #   with:
+      #     token: ${{ secrets.CODECOV_TOKEN }}
+      #     file: ./coverage.txt

.golangci.yml

@@ -0,0 +1,39 @@
+run:
+  timeout: 5m
+  modules-download-mode: readonly
+
+linters:
+  enable:
+    - errcheck
+    - gofmt
+    - goimports
+    - gosec
+    - gosimple
+    - govet
+    - ineffassign
+    - misspell
+    - revive
+    - staticcheck
+    - typecheck
+    - unconvert
+    - unused
+
+issues:
+  exclude-use-default: false
+  include:
+    - EXC0012 # EXC0012 revive: Annoying issue about not having a comment. The rare codebase has such comments
+    - EXC0014 # EXC0014 revive: Annoying issue about not having a comment. The rare codebase has such comments
+
+linters-settings:
+  revive:
+    rules:
+      - name: package-comments
+        disabled: true
+      - name: duplicated-imports
+        severity: warning
+      - name: exported
+        arguments:
+          - disableStutteringCheck
+
+  goimports:
+    local-prefixes: github.com/rollkit

.markdownlint.yaml

@@ -0,0 +1,6 @@
+default: true
+MD010:
+  code_blocks: false
+MD013: false
+MD024:
+  allow_different_nesting: true

.yamllint.yml

@@ -0,0 +1,9 @@
+---
+# Built from docs https://yamllint.readthedocs.io/en/stable/configuration.html
+extends: default
+
+rules:
+  # 120 chars should be enough, but don't fail if a line is longer
+  line-length:
+    max: 120
+    level: warning

Makefile

@@ -0,0 +1,57 @@
+# Define pkgs, run, and cover variables for test so that we can override them in
+# the terminal more easily.
+pkgs := $(shell go list ./...)
+run := .
+count := 1
+
+## help: Show this help message
+help: Makefile
+	@echo " Choose a command run in "$(PROJECTNAME)":"
+	@sed -n 's/^##//p' $< | column -t -s ':' |  sed -e 's/^/ /'
+.PHONY: help
+
+## cover: generate to code coverage report.
+# cover:
+# 	@echo "--> Generating Code Coverage"
+# 	@go install github.com/ory/go-acc@latest
+# 	@go-acc -o coverage.txt $(pkgs)
+# .PHONY: cover
+
+## deps: Install dependencies
+deps:
+	@echo "--> Installing dependencies"
+	@go mod download
+	@go mod tidy
+.PHONY: deps
+
+## lint: Run linters golangci-lint and markdownlint.
+lint: vet
+	@echo "--> Running golangci-lint"
+	@golangci-lint run
+	@echo "--> Running markdownlint"
+	@markdownlint --config .markdownlint.yaml --ignore './cmd/rollkit/docs/*.md' '**/*.md'
+	@echo "--> Running yamllint"
+	@yamllint --no-warnings . -c .yamllint.yml
+
+.PHONY: lint
+
+## fmt: Run fixes for linters.
+fmt:
+	@echo "--> Formatting markdownlint"
+	@markdownlint --config .markdownlint.yaml --ignore './cmd/rollkit/docs/*.md' '**/*.md' -f
+	@echo "--> Formatting go"
+	@golangci-lint run --fix
+.PHONY: fmt
+
+## vet: Run go vet
+vet: 
+	@echo "--> Running go vet"
+	@echo $(pkgs)
+	@go vet $(pkgs)
+.PHONY: vet
+
+## test: Running unit tests
+test: vet
+	@echo "--> No unit tests"
+# 	@go test -v -race -covermode=atomic -coverprofile=coverage.txt $(pkgs) -run $(run) -count=$(count)
+.PHONY: test