Merge pull request #42 from btnguyen2k/dev

Prepare to release next version

Author: btnguyen2k

.github/codeql/codeql-config.yaml

@@ -0,0 +1,7 @@
+name: "CodeQL config"
+
+paths-ignore:
+  - module_test
+
+queries:
+  - uses: security-and-quality

.github/workflows/ci.yaml

@@ -13,10 +13,10 @@ jobs:
     runs-on: ubuntu-latest
     name: Check format with go fmt
     steps:
-      - name: Check out code
+      - name: Checkout code
         uses: actions/checkout@v4
       - name: Set up Go env
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           # pick one Go version to check format
           go-version: '1.18'
@@ -29,10 +29,10 @@ jobs:
     name: GoLint
     runs-on: ubuntu-latest
     steps:
-      - name: Check out code
+      - name: Checkout code
         uses: actions/checkout@v4
       - name: Set up Go env
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           # pick one Go version for linting
           go-version: '1.18'
@@ -49,10 +49,10 @@ jobs:
         go: [ '1.18', 'oldstable', 'stable' ]
     name: Run tests with Go ${{ matrix.go }}
     steps:
-      - name: Check out code
+      - name: Checkout code
         uses: actions/checkout@v4
       - name: Set up Go env
-        uses: actions/setup-go@v4
+        uses: actions/setup-go@v5
         with:
           go-version: ${{ matrix.go }}
       - name: Run tests

.github/workflows/codeql.yaml

@@ -0,0 +1,40 @@
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ '*' ]
+  pull_request:
+    branches: [ '*' ]
+  schedule:
+    # run every Saturday at 00:00 UTC
+    - cron: '0 0 * * 6'
+
+jobs:
+  Analyze:
+    name: Analyze
+    runs-on: ubuntu-latest
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+    strategy:
+      fail-fast: false
+      matrix:
+        # Learn more about CodeQL language support at https://git.io/codeql-language-support
+        language: [ 'go' ]
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+      - name: Initialize CodeQL
+        uses: github/codeql-action/init@v3
+        with:
+          languages: ${{ matrix.language }}
+          config-file: ./.github/codeql/codeql-config.yaml
+      # Autobuild attempts to build any compiled languages (C/C++, C#, Java, etc).
+      # If this step fails, then you should remove it and run the build manually (see below)
+      # ℹ️ Command-line programs to run using the OS shell.
+      # 📚 https://git.io/JvXDl
+      - name: Autobuild
+        uses: github/codeql-action/autobuild@v3
+      - name: Perform CodeQL Analysis
+        uses: github/codeql-action/analyze@v3

.github/workflows/release.yaml

@@ -26,7 +26,7 @@ jobs:
       VERSION: ${{ steps.release_dry_run.outputs.releaseVersion }}
       RELEASE_NOTES: ${{ steps.release_dry_run.outputs.releaseNotes }}
     steps:
-      - name: Check out code
+      - name: Checkout code
         uses: actions/checkout@v4
       - name: Install Node
         uses: actions/setup-node@v4

README.md

@@ -14,6 +14,7 @@ Template to quickly spin up a Go module project.
   - `dependabot.yaml`, `automerge-dependabot.yaml`: automatically update dependencies and merge PRs from dependabot.
   - `ci.yaml`: automatically run tests and generate code coverage report.
   - `release.yaml`: automatically create a new release.
+  - `codeql.yaml`: automatically run CodeQL analysis.
 
 ## Usage
 
@@ -32,6 +33,7 @@ Template to quickly spin up a Go module project.
 Workflows implemented by this template are as the following:
 
 - `dependabot.yaml` configures dependencies are checked and updated weekly. `dependabot` will create a PR for each dependency update. `automerge-dependabot.yaml` is triggered to automatically merged PRs to `main` branch.
+- `codeql.yaml` is triggered on every push, pr and periodically to run CodeQL analysis.
 - `ci.yaml` is triggered on every push to any branch to run tests and generate code coverage report.
 - Once PR is approved and merged to `release` branch, `release.yaml` is triggered to create a new release. Then a new PR is created to merge `release` branch to `main` branch.