Skip to content

Commit d02cd58

Browse files
lucacomelucacome
authored
Add workflows and linters (#2)
1 parent fe33e67 commit d02cd58

11 files changed

+352
-1
lines changed

‎.editorconfig

+13
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
end_of_line = lf
6+
insert_final_newline = true
7+
trim_trailing_whitespace = true
8+
indent_size = 4
9+
indent_style = tab
10+
11+
[*.{md,yml,yaml}]
12+
indent_size = 2
13+
indent_style = space

‎.github/dependabot.yml

+11
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
version: 2
2+
updates:
3+
- package-ecosystem: github-actions
4+
directory: /
5+
schedule:
6+
interval: daily
7+
8+
- package-ecosystem: gomod
9+
directory: /
10+
schedule:
11+
interval: daily

‎.github/labeler.yml

+28
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
change:
2+
- head-branch: ["^change/"]
3+
4+
enhancement:
5+
- head-branch: ["^feature/", "^feat/", "^enhancement/", "^enh/"]
6+
7+
bug:
8+
- head-branch: ["^fix/", "^bug/"]
9+
10+
chore:
11+
- head-branch: ["^chore/"]
12+
13+
tech-debt:
14+
- head-branch: ["^tech-debt/", "^techdebt/", "^debt/"]
15+
16+
documentation:
17+
- head-branch: ["^docs/", "^doc/"]
18+
- changed-files:
19+
- any-glob-to-any-file: "**/*.md"
20+
21+
dependencies:
22+
- head-branch:
23+
["^deps/", "^dep/", "^dependabot/", "pre-commit-ci-update-config"]
24+
- changed-files:
25+
- any-glob-to-any-file: ["go.mod", "go.sum"]
26+
27+
tests:
28+
- head-branch: ["^tests/", "^test/"]

‎.github/workflows/dependency-review.yml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
name: "Dependency Review"
2+
on: [pull_request]
3+
4+
permissions:
5+
contents: read
6+
7+
jobs:
8+
dependency-review:
9+
runs-on: ubuntu-22.04
10+
permissions:
11+
contents: read
12+
pull-requests: write
13+
steps:
14+
- name: "Checkout Repository"
15+
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
16+
17+
- name: "Dependency Review"
18+
uses: actions/dependency-review-action@4901385134134e04cec5fbe5ddfe3b2c5bd5d976 # v4.0.0
19+
with:
20+
config-file: "nginxinc/k8s-common/dependency-review-config.yml@main"

‎.github/workflows/labeler.yml

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
name: "Pull Request Labeler"
2+
on:
3+
- pull_request_target
4+
5+
permissions:
6+
contents: read
7+
8+
jobs:
9+
triage:
10+
permissions:
11+
contents: read
12+
pull-requests: write
13+
runs-on: ubuntu-22.04
14+
steps:
15+
- uses: actions/labeler@8558fd74291d67161a8a78ce36a881fa63b766a9 # v5.0.0
16+
with:
17+
repo-token: "${{ secrets.GITHUB_TOKEN }}"
18+
sync-labels: true

‎.github/workflows/lint.yml

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
name: Lint
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
9+
concurrency:
10+
group: ${{ github.ref_name }}-lint
11+
cancel-in-progress: true
12+
13+
permissions:
14+
contents: read
15+
16+
jobs:
17+
lint:
18+
name: Lint
19+
runs-on: ubuntu-22.04
20+
steps:
21+
- name: Checkout Repository
22+
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
23+
24+
- name: Setup Golang Environment
25+
uses: actions/setup-go@0c52d547c9bc32b1aa3301fd7a9cb496313a4491 # v5.0.0
26+
with:
27+
go-version: stable
28+
29+
- name: Lint Code
30+
uses: golangci/golangci-lint-action@3a919529898de77ec3da873e3063ca4b10e7f5cc # v3.7.0
31+
with:
32+
args: --timeout 10m0s
33+
34+
actionlint:
35+
name: Actionlint
36+
runs-on: ubuntu-22.04
37+
steps:
38+
- name: Checkout Repository
39+
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
40+
41+
- uses: reviewdog/action-actionlint@6a38513dd4d2e818798c5c73d0870adbb82de4a4 # v1.41.0
42+
with:
43+
actionlint_flags: -shellcheck ""
44+
45+
markdown-lint:
46+
name: Markdown Lint
47+
runs-on: ubuntu-22.04
48+
steps:
49+
- name: Checkout Repository
50+
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
51+
52+
- uses: DavidAnson/markdownlint-cli2-action@510b996878fc0d1a46c8a04ec86b06dbfba09de7 # v15.0.0
53+
with:
54+
config: ${{ github.workspace }}/.markdownlint-cli2.yaml
55+
globs: "**/*.md"
56+
57+
yaml-lint:
58+
name: Yaml Lint
59+
runs-on: ubuntu-22.04
60+
steps:
61+
- name: Checkout Repository
62+
uses: actions/checkout@b4ffde65f46336ab88eb53be808477a3936bae11 # v4.1.1
63+
64+
- name: Install yamllint
65+
run: pip install yamllint
66+
67+
- name: Lint YAML files
68+
run: yamllint .

‎.golangci.yml

+68
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,68 @@
1+
linters-settings:
2+
misspell:
3+
locale: US
4+
revive:
5+
ignore-generated-header: true
6+
rules:
7+
- name: blank-imports
8+
- name: context-as-argument
9+
- name: context-keys-type
10+
- name: empty-block
11+
- name: error-naming
12+
- name: error-return
13+
- name: error-strings
14+
- name: errorf
15+
- name: exported
16+
- name: if-return
17+
- name: increment-decrement
18+
- name: indent-error-flow
19+
- name: package-comments
20+
- name: range
21+
- name: receiver-naming
22+
- name: redefines-builtin-id
23+
- name: superfluous-else
24+
- name: time-naming
25+
- name: unexported-return
26+
- name: unreachable-code
27+
- name: unused-parameter
28+
- name: var-declaration
29+
- name: var-naming
30+
gocyclo:
31+
min-complexity: 15
32+
govet:
33+
enable:
34+
- fieldalignment
35+
lll:
36+
line-length: 120
37+
linters:
38+
enable:
39+
- asciicheck
40+
- errcheck
41+
- errorlint
42+
- gocyclo
43+
- gofmt
44+
- gofumpt
45+
- goimports
46+
- gosec
47+
- gosimple
48+
- govet
49+
- ineffassign
50+
- lll
51+
- makezero
52+
- misspell
53+
- nilerr
54+
- noctx
55+
- predeclared
56+
- revive
57+
- staticcheck
58+
- typecheck
59+
- unconvert
60+
- unparam
61+
- unused
62+
- wastedassign
63+
disable-all: true
64+
issues:
65+
max-issues-per-linter: 0
66+
max-same-issues: 0
67+
run:
68+
timeout: 3m

‎.markdownlint-cli2.yaml

+20
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# Rule configuration.
2+
# For rule descriptions and how to fix: https://github.com/DavidAnson/markdownlint/tree/main#rules--aliases
3+
config:
4+
ul-style:
5+
style: dash
6+
no-hard-tabs: false
7+
no-multiple-blanks: false
8+
line-length: false
9+
blanks-around-headers: false
10+
no-duplicate-heading:
11+
siblings_only: true
12+
no-inline-html: false
13+
no-bare-urls: false
14+
no-emphasis-as-heading: false
15+
first-line-h1: false
16+
code-block-style: false
17+
18+
# Define glob expressions to ignore
19+
ignores:
20+
- ".github/"

‎.pre-commit-config.yaml

+60
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
# See https://pre-commit.com for more information
2+
# See https://pre-commit.com/hooks.html for more hooks
3+
repos:
4+
- repo: https://github.com/pre-commit/pre-commit-hooks
5+
rev: v4.5.0
6+
hooks:
7+
- id: trailing-whitespace
8+
exclude: (^tests/results/)
9+
- id: end-of-file-fixer
10+
- id: check-yaml
11+
args: [--allow-multiple-documents]
12+
- id: check-added-large-files
13+
- id: check-merge-conflict
14+
- id: check-case-conflict
15+
- id: check-vcs-permalinks
16+
- id: check-json
17+
- id: pretty-format-json
18+
args: [--autofix, --no-sort-keys, --no-ensure-ascii]
19+
- id: mixed-line-ending
20+
args: [--fix=lf]
21+
- id: no-commit-to-branch
22+
- id: detect-private-key
23+
exclude: (^examples/|^docs/|.*_test.go$)
24+
25+
- repo: https://github.com/gitleaks/gitleaks
26+
rev: v8.18.1
27+
hooks:
28+
- id: gitleaks
29+
30+
- repo: local
31+
hooks:
32+
- id: golang-diff
33+
name: create-go-diff
34+
entry: bash -c 'git diff -p origin/main > /tmp/diff.patch'
35+
language: system
36+
types: [go]
37+
pass_filenames: false
38+
39+
- repo: https://github.com/golangci/golangci-lint
40+
rev: v1.55.2
41+
hooks:
42+
- id: golangci-lint
43+
args: [--new-from-patch=/tmp/diff.patch]
44+
45+
# Rules are in .markdownlint-cli2.yaml file
46+
# See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md for rule descriptions
47+
- repo: https://github.com/DavidAnson/markdownlint-cli2
48+
rev: v0.12.1
49+
hooks:
50+
- id: markdownlint-cli2
51+
52+
# Rules are in .yamllint.yaml file
53+
# See https://yamllint.readthedocs.io/en/stable/rules.html# for rule descriptions
54+
- repo: https://github.com/adrienverge/yamllint.git
55+
rev: v1.33.0
56+
hooks:
57+
- id: yamllint
58+
59+
ci:
60+
skip: [golang-diff, golangci-lint, markdownlint-cli2, yamllint]

‎.yamllint.yaml

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
yaml-files:
3+
- "*.yaml"
4+
- "*.yml"
5+
6+
ignore:
7+
- .github/workflows/
8+
9+
rules:
10+
braces: enable
11+
brackets: enable
12+
colons: enable
13+
commas: enable
14+
comments:
15+
require-starting-space: true
16+
ignore-shebangs: true
17+
min-spaces-from-content: 1
18+
comments-indentation: enable
19+
document-end: disable
20+
document-start: disable
21+
empty-lines: enable
22+
empty-values: enable
23+
float-values: disable
24+
hyphens: enable
25+
indentation:
26+
spaces: consistent
27+
indent-sequences: consistent
28+
check-multi-line-strings: true
29+
key-duplicates: enable
30+
key-ordering: disable
31+
line-length:
32+
max: 120
33+
allow-non-breakable-words: true
34+
allow-non-breakable-inline-mappings: true
35+
ignore: |
36+
.github/workflows/
37+
.goreleaser.yml
38+
new-line-at-end-of-file: enable
39+
new-lines: enable
40+
octal-values: disable
41+
quoted-strings: disable
42+
trailing-spaces: enable
43+
truthy:
44+
ignore: |
45+
.github/workflows/

‎README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
# telemetry-exporter
1+
# telemetry-exporter

0 commit comments

Comments
 (0)