chore: make linters happy (#835)

.github/dependabot.yml

@@ -0,0 +1,9 @@
+version: 2
+updates:
+  -
+    package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    commit-message:
+      prefix: ci

.github/linters/.gitleaks.toml

@@ -0,0 +1,13 @@
+
+title = "gitleaks config"
+
+[extend]
+# useDefault will extend the base configuration with the default gitleaks config:
+# https://github.com/zricethezav/gitleaks/blob/master/config/gitleaks.toml
+useDefault = true
+
+[allowlist]
+paths = [
+  '''authorization_test.go''',
+  '''(.*?)(key)'''
+]

.github/linters/.htmlhintrc

@@ -4,7 +4,7 @@
   "attr-value-double-quotes": true,
   "attr-value-not-empty": false,
   "attr-no-duplication": true,
-  "doctype-first": true,
+  "doctype-first": false,
   "tag-pair": true,
   "tag-self-close": false,
   "spec-char-escape": true,

.github/linters/.markdown-lint.yml

@@ -21,9 +21,9 @@
 MD004: false                  # Unordered list style
 MD007:
   indent: 2                   # Unordered list indentation
-MD013:
-  line_length: 400            # Line length 80 is far too short
-  tables: false
+MD010:
+  ignore_code_languages: [caddyfile]
+MD013: false
 MD026:
   punctuation: ".,;:!。，；:"  # List of not allowed
 MD029: false                  # Ordered list item prefix

.github/linters/.textlintrc

@@ -0,0 +1,13 @@
+{
+  "filters": {
+    "comments": true
+  },
+  "rules": {
+    "terminology": {
+        "defaultTerms": true,
+        "exclude": [
+          "(?<=(?:\\w+[^.?!])? )internet\\b(?! explorer)"
+        ]
+    }
+  }
+}

.github/workflows/cd.yml

@@ -1,12 +1,16 @@
 name: Release Hub
 
 on:
+  pull_request:
+    branches:
+      - main
   push:
-    tags:
-      - 'v*'
     branches:
-      - '*'
-  pull_request:
+      - main
+    tags:
+      - v*.*.*
+  workflow_dispatch:
+    inputs: {}
 
 permissions:
   contents: write

.github/workflows/ci-chart.yml

@@ -1,8 +1,14 @@
 name: Lint and Test Chart
 
 on:
-  push:
   pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+    tags:
+      - v*.*.*
 
 jobs:
   lint-test:

.github/workflows/ci.yml

@@ -1,8 +1,14 @@
 name: Lint and Test Hub
 
 on:
-  push:
   pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+    tags:
+      - v*.*.*
 
 env:
   GO111MODULE: 'on'
@@ -32,7 +38,7 @@ jobs:
     strategy:
       matrix:
         go: [ '1.20', '1.21' ]
-
+      fail-fast: false
     name: Test
     runs-on: ubuntu-latest
     steps:
@@ -54,21 +60,20 @@ jobs:
         run: go test -race -covermode atomic -coverprofile=profile.cov -coverpkg=github.com/dunglas/mercure ./...
 
       - name: Test Caddy module
+        working-directory: caddy/
         run: |
           go test -timeout 1m -race -covermode atomic -coverprofile=profile.cov -coverpkg=github.com/dunglas/mercure ./...
           sed '1d' profile.cov >> ../profile.cov
-        working-directory: ./caddy
 
       - name: Upload coverage results
         uses: shogo82148/actions-goveralls@v1
         with:
           path-to-profile: profile.cov
+          parallel: true
 
       - name: Start Mercure
-        run: |
-          cd caddy/mercure
-          sudo MERCURE_PUBLISHER_JWT_KEY='!ChangeThisMercureHubJWTSecretKey!' MERCURE_SUBSCRIBER_JWT_KEY='!ChangeThisMercureHubJWTSecretKey!' go run main.go start --config ../../Caddyfile.dev
-          cd -
+        working-directory: caddy/mercure/
+        run: sudo MERCURE_PUBLISHER_JWT_KEY='!ChangeThisMercureHubJWTSecretKey!' MERCURE_SUBSCRIBER_JWT_KEY='!ChangeThisMercureHubJWTSecretKey!' go run main.go start --config ../../Caddyfile.dev
 
       - uses: actions/setup-node@v3
         with:
@@ -87,3 +92,11 @@ jobs:
       - name: Run Playwright tests
         working-directory: conformance-tests/
         run: npx playwright test
+
+  finish:
+    needs: test
+    runs-on: ubuntu-latest
+    steps:
+      - uses: shogo82148/actions-goveralls@v1
+        with:
+          parallel-finished: true

.github/workflows/lint.yml

@@ -1,7 +1,14 @@
 name: Lint Docs and Non-Go Code
+
 on:
-  push:
   pull_request:
+    branches:
+      - main
+  push:
+    branches:
+      - main
+    tags:
+      - v*.*.*
 
 jobs:
   lint:
@@ -13,8 +20,11 @@ jobs:
       - name: Lint Code Base
         uses: super-linter/super-linter/slim@v4
         env:
-          VALIDATE_ALL_CODEBASE: false
+          VALIDATE_ALL_CODEBASE: true
           VALIDATE_GO: false
+          VALIDATE_PHP_PHPCS: false
+          VALIDATE_KUBERNETES_CONFORM: false
           VALIDATE_KUBERNETES_KUBEVAL: false
+          VALIDATE_TYPESCRIPT_STANDARD: false
           DEFAULT_BRANCH: main
           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.golangci.yml

@@ -44,3 +44,4 @@ issues:
         - godox
         - noctx
         - wrapcheck
+        - goconst

.markdownlintignore

@@ -0,0 +1 @@
+spec/**

.textlintignore

@@ -0,0 +1 @@
+spec/mercure.txt

Dockerfile.legacy

@@ -1,3 +1,4 @@
+# hadolint ignore=DL3006
 FROM gcr.io/distroless/static
 COPY mercure /
 CMD ["/mercure"]

README.md

@@ -18,7 +18,7 @@ It is especially useful to publish async and real-time updates of resources serv
 * [Full documentation](https://mercure.rocks/docs)
 * [Demo](https://demo.mercure.rocks/)
 
-[The protocol](https://mercure.rocks/spec) is maintained in this repository and is also available as [an Internet Draft](https://datatracker.ietf.org/doc/draft-dunglas-mercure/).
+[The protocol](https://mercure.rocks/spec) is maintained in this repository and is also available as [an Internet-Draft](https://datatracker.ietf.org/doc/draft-dunglas-mercure/).
 
 A reference, production-grade, implementation of [**a Mercure hub**](https://mercure.rocks/docs/hub/install) (the server) is also available in this repository.
 It's free software (AGPL) written in Go. It is provided along with a library that can be used in any Go application to implement the Mercure protocol directly (without a hub) and [an official Docker image](https://hub.docker.com/r/dunglas/mercure).
@@ -31,7 +31,7 @@ See [CONTRIBUTING.md](CONTRIBUTING.md).
 
 ## License and Copyright
 
-See https://mercure.rocks/docs/hub/license.
+See [license information](https://mercure.rocks/docs/hub/license).
 
 ## Credits
 

authorization.go

@@ -28,6 +28,7 @@ type role int
 
 const (
 	defaultCookieName      = "mercureAuthorization"
+	bearerPrefix           = "Bearer "
 	roleSubscriber    role = iota
 	rolePublisher
 )
@@ -54,7 +55,7 @@ var (
 func authorize(r *http.Request, jwtConfig *jwtConfig, publishOrigins []string, cookieName string) (*claims, error) {
 	authorizationHeaders, headerExists := r.Header["Authorization"]
 	if headerExists {
-		if len(authorizationHeaders) != 1 || len(authorizationHeaders[0]) < 48 || authorizationHeaders[0][:7] != "Bearer " {
+		if len(authorizationHeaders) != 1 || len(authorizationHeaders[0]) < 48 || authorizationHeaders[0][:7] != bearerPrefix {
 			return nil, ErrInvalidAuthorizationHeader
 		}