chore: init

Author: kilianc

.chglog/CHANGELOG.tpl.md

@@ -0,0 +1,11 @@
+{{ range .Versions }}
+{{ $tag := .Tag.Name }}
+<a name="{{ .Tag.Name }}"></a>
+## {{ if .Tag.Previous }}[{{ .Tag.Name }}]({{ $.Info.RepositoryURL }}/compare/{{ .Tag.Previous.Name }}...{{ .Tag.Name }}){{ else }}{{ .Tag.Name }}{{ end }} <kbd>{{ datetime "2006/01/02" .Tag.Date }}</kbd>
+
+{{ range .CommitGroups -}}
+{{ $type := .Title }}
+{{ range .Commits -}}{{$type}} {{ .Subject }}<br>{{ end }}
+{{ end -}}
+
+{{ end -}}

.chglog/config.yml

@@ -0,0 +1,31 @@
+style: github
+template: CHANGELOG.tpl.md
+info:
+  title: CHANGELOG
+  repository_url: https://github.com/kilianc/cli-name
+options:
+  commits:
+    filters:
+      Type:
+        - feat
+        - fix
+        - chore
+  commit_groups:
+    group_by: Type
+    sort_by: Title
+    title_order:
+      - fix
+      - feat
+      - chore
+    title_maps:
+      feat: ✨
+      fix: 🐛
+      chore: 🧹
+  header:
+    pattern: "^(\\w*)\\:\\s(.*)$"
+    pattern_maps:
+      - Type
+      - Subject
+  notes:
+    keywords:
+      - BREAKING CHANGE

.dockerignore

@@ -0,0 +1,7 @@
+*
+!cmd
+!internal
+!pkg
+!.golangci.yml
+!go.*
+!Makefile

.github/update-code-coverage-comment.js

@@ -0,0 +1,46 @@
+const fs = require('fs')
+
+const updateCodeCoverageComment = module.exports = async ({ context, github }) => {
+  const comments = await github.rest.issues.listComments({
+    owner: context.repo.owner,
+    repo: context.repo.repo,
+    issue_number: context.issue.number,
+    per_page: 100
+  })
+
+  const coverageComment = comments.data.find((comment) => {
+    return comment.body.startsWith('<!-- coverage -->')
+  }) || {}
+
+  const coverageText = fs.readFileSync('cover.txt', 'utf8').split('\n').slice(0, -1)
+  const coverageTextSummary = coverageText[coverageText.length-1].split('\t').pop()
+
+  const commentBody = [
+    '<!-- coverage -->',
+    `### Code Coverage Report ${process.env.REVISION}`,
+    '```',
+    `Total: ${coverageTextSummary}`,
+    '```',
+    '<details>',
+    '<summary>Full coverage report</summary>',
+    '',
+    '```',
+    ...coverageText,
+    '```',
+    '</details>',
+  ].join('\n')
+
+  const upsertCommentOptions = {
+    owner: context.repo.owner,
+    repo: context.repo.repo,
+    issue_number: context.issue.number,
+    comment_id: coverageComment.id,
+    body: commentBody
+  }
+
+  if (coverageComment.id) {
+    await github.rest.issues.updateComment(upsertCommentOptions)
+  } else {
+    await github.rest.issues.createComment(upsertCommentOptions)
+  }
+}

.github/upload-release-assets.js

@@ -0,0 +1,24 @@
+const fs = require('fs')
+
+const uploadReleaseAssets = module.exports = async ({ context, github }, tag) => {
+  const files = fs.readdirSync('bin').filter(file => file.endsWith('.tar.gz'))
+
+  const release = await github.rest.repos.getReleaseByTag({
+    owner: context.repo.owner,
+    repo: context.repo.repo,
+    tag: tag.replace('refs/tags/', '')
+  })
+
+  for (const file of files) {
+    console.log(`Uploading bin/${file} to release ${tag.replace('refs/tags/', '')} id=${release.data.id}`)
+
+    await github.rest.repos.uploadReleaseAsset({
+      owner: context.repo.owner,
+      repo: context.repo.repo,
+      release_id: release.data.id,
+      name: file,
+      data: fs.readFileSync(`bin/${file}`),
+      url: release.data.upload_url
+    })
+  }
+}

.github/workflows/go.yaml

@@ -0,0 +1,55 @@
+# This workflow will build a golang project
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-go
+
+name: Go
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    branches: [ "main" ]
+
+env:
+  REVISION: ${{ github.event.pull_request.head.sha || github.sha }}
+
+jobs:
+  build:
+    name: Build and Test
+    permissions:
+      issues: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+
+    - name: Set up Go
+      uses: actions/setup-go@v4
+      with:
+        go-version: '1.22'
+
+    - name: Docker Build
+      run: make docker-build
+
+    - name: Build
+      run: make build
+
+    - name: Test
+      run: make test
+
+    - name: Create cover.txt
+      run: make cover.txt
+
+    - name: Post Code Coverage Comment
+      uses: actions/github-script@v5
+      if: ${{ github.event_name == 'pull_request' }}
+      with:
+        script: await require('${{ github.workspace }}/.github/update-code-coverage-comment.js')({ context, github })
+
+    - name: Cover Check
+      run: make check-cover
+
+    - name: Version Check
+      run: make check-version
+
+    - name: Commit Check
+      run: make check-commit message='${{ github.event.pull_request.title }}'

.github/workflows/release.yaml

@@ -0,0 +1,42 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*.*.*"
+  workflow_dispatch:
+    inputs:
+      tag:
+        description: 'Tag to build (e.g., v1.2.3)'
+        required: true
+
+jobs:
+  upload-release-assets:
+    name: Upload Release Assets
+    permissions:
+      contents: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          ref: ${{ github.event.inputs.tag || github.ref }}
+
+      - name: Set up Go
+        uses: actions/setup-go@v4
+        with:
+          go-version: '1.22'
+
+      - name: Version Check
+        run: make version-check tag=${{ github.event.inputs.tag || github.ref }}
+
+      - name: Tarball
+        run: make release
+
+      - name: Upload Release Assets
+        uses: actions/github-script@v5
+        with:
+          script: |
+            const script = require('${{ github.workspace }}/.github/upload-release-assets.js')
+            const tag = '${{ github.event.inputs.tag || github.ref }}'
+            await script({ context, github }, tag)

.gitignore

@@ -0,0 +1,24 @@
+# https://github.com/github/gitignore/blob/main/Go.gitignore
+# https://github.com/github/gitignore/blob/main/community/Golang/Go.AllowList.gitignore
+#
+# Allowlisting gitignore template for GO projects prevents us
+# from adding various unwanted local files, such as generated
+# files, developer configurations or IDE-specific files etc.
+#
+# Recommended: Go.AllowList.gitignore
+
+# Ignore everything
+*
+
+# But not these files...
+!/.gitignore
+
+!*.go
+!go.sum
+!go.mod
+
+!README.md
+!Makefile
+
+# ...even if they are in subdirectories
+!*/

.golangci.yaml

@@ -0,0 +1,34 @@
+linters:
+  enable-all: false
+  disable-all: true
+  fast: false
+  enable:
+    - errchkjson
+    - errorlint
+    - godot
+    - gofumpt
+    - intrange
+    - ireturn
+    - lll
+    - nestif
+    - nilerr
+    - nlreturn
+    - revive
+    - testifylint
+    - wrapcheck
+    - wsl
+
+issues:
+  exclude-files:
+    - "mock.*\\.go"
+  exclude-rules:
+    - path: '.+_test\.go'
+      linters:
+        - forcetypeassert
+
+output:
+  print-issued-lines: false
+
+linters-settings:
+  gofumpt:
+    module-path: "cli-name"

.vscode/launch.json

@@ -0,0 +1,15 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Launch Package",
+      "type": "go",
+      "request": "launch",
+      "mode": "auto",
+      "program": "${fileDirname}"
+    }
+  ]
+}