-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
added external-secrets related markdown files and workflows
- Loading branch information
Showing
15 changed files
with
591 additions
and
0 deletions.
There are no files selected for viewing
Validating CODEOWNERS rules …
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
* @external-secrets/maintainers |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,25 @@ | ||
--- | ||
name: Bug report | ||
about: Create a report to help us improve | ||
title: '' | ||
labels: kind/bug | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Describe the bug** | ||
A clear and concise description of what the bug is. | ||
|
||
**To Reproduce** | ||
Steps to reproduce the behavior: | ||
1. provide all relevant manifests | ||
2. provide the Kubernetes and ESO version | ||
|
||
**Expected behavior** | ||
A clear and concise description of what you expected to happen. | ||
|
||
**Screenshots** | ||
If applicable, add screenshots to help explain your problem. | ||
|
||
**Additional context** | ||
Add any other context about the problem here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
--- | ||
name: Create Release | ||
about: Release template to track the next release | ||
title: Release x.y | ||
labels: area/release | ||
assignees: '' | ||
|
||
--- | ||
|
||
This Issue tracks the next ESO release. Please follow the guideline below. If anything is missing or unclear, please add a comment to this issue so this can be improved after the release. | ||
|
||
#### Preparation Tasks | ||
|
||
- [ ] ask in `#external-secrets-dev` if we're ready for a release cut-off or if something needs to get urgently in | ||
- [ ] docs: [stability & support page](https://external-secrets.io/main/introduction/stability-support/) is up to date | ||
- [ ] version table | ||
- [ ] Provider Stability and Support table | ||
- [ ] Provider Feature Support table | ||
- [ ] docs: update [roadmap page](https://external-secrets.io/main/contributing/roadmap/) | ||
- [ ] tidy up [Project Board](https://github.com/orgs/external-secrets/projects/2) | ||
- [ ] move issues to next milestone | ||
- [ ] close milestone | ||
|
||
#### Release Execution | ||
|
||
- [ ] Follow the [Release Process guide](https://external-secrets.io/main/contributing/release/) | ||
|
||
#### After Release Tasks | ||
|
||
- [ ] Announce release on `#external-secrets` in Slack |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
name: Feature request | ||
about: Suggest an idea for this project | ||
title: '' | ||
labels: kind/feature | ||
assignees: '' | ||
|
||
--- | ||
|
||
**Is your feature request related to a problem? Please describe.** | ||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
**Describe the solution you'd like** | ||
A clear and concise description of what you want to happen. | ||
|
||
**Describe alternatives you've considered** | ||
A clear and concise description of any alternative solutions or features you've considered. | ||
|
||
**Additional context** | ||
Add any other context or screenshots about the feature request here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
version: 2 | ||
|
||
updates: | ||
- package-ecosystem: "github-actions" | ||
directory: "/" | ||
groups: | ||
# xref: https://docs.github.com/en/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file#groups | ||
ci: | ||
patterns: | ||
- "*" | ||
schedule: | ||
interval: "weekly" | ||
day: "sunday" | ||
- package-ecosystem: "gomod" | ||
directory: "/" | ||
groups: | ||
go: | ||
update-types: ["minor","patch"] | ||
schedule: | ||
interval: "weekly" | ||
day: "sunday" |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
## Problem Statement | ||
|
||
What is the problem you're trying to solve? | ||
|
||
## Related Issue | ||
|
||
Fixes #... | ||
|
||
## Proposed Changes | ||
|
||
How do you like to solve the issue and why? | ||
|
||
## Checklist | ||
|
||
- [ ] I have read the [contribution guidelines](https://external-secrets.io/latest/contributing/process/#submitting-a-pull-request) | ||
- [ ] All commits are signed with `git commit --signoff` | ||
- [ ] My changes have reasonable test coverage | ||
- [ ] All tests pass with `make test` | ||
- [ ] I ensured my PR is ready for review with `make reviewable` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,31 @@ | ||
name: Check for diff after manifest and generated targets | ||
|
||
on: | ||
pull_request: {} | ||
|
||
jobs: | ||
diff-check-manifests: | ||
name: Check for diff | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
with: | ||
fetch-depth: 0 | ||
- name: Setup Go | ||
uses: actions/setup-go@v5 | ||
with: | ||
go-version-file: '${{ github.workspace }}/go.mod' | ||
- name: Restore Go cache | ||
uses: actions/cache@v4 | ||
with: | ||
path: /home/runner/work/_temp/_github_home/go/pkg/mod | ||
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }} | ||
restore-keys: | | ||
${{ runner.os }}-go- | ||
- name: go mod tidy | ||
run: | | ||
go mod tidy | ||
- name: Check for diff | ||
run: | | ||
git diff --exit-code --shortstat |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
name: test and lint | ||
|
||
on: | ||
pull_request: | ||
paths-ignore: | ||
- 'CODE_OF_CONDUCT.md' | ||
- 'README.md' | ||
- 'Contributing.md' | ||
workflow_call: | ||
|
||
push: | ||
branches: | ||
- main | ||
|
||
permissions: | ||
contents: read # for actions/checkout to fetch code | ||
|
||
jobs: | ||
run-test-suite: | ||
runs-on: ubuntu-latest | ||
steps: | ||
- name: Checkout | ||
uses: actions/checkout@v4 | ||
- name: Setup Go | ||
uses: actions/setup-go@v5 | ||
with: | ||
go-version-file: '${{ github.workspace }}/go.mod' | ||
- name: Restore Go cache | ||
uses: actions/cache@v4 | ||
with: | ||
path: /home/runner/work/_temp/_github_home/go/pkg/mod | ||
key: ${{ runner.os }}-go-${{ hashFiles('**/go.sum') }} | ||
restore-keys: | | ||
${{ runner.os }}-go- | ||
- name: Run lint | ||
run: make lint | ||
- name: Run tests | ||
run: make test |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,127 @@ | ||
run: | ||
timeout: 10m | ||
|
||
linters-settings: | ||
gci: | ||
sections: | ||
- "standard" | ||
- "default" | ||
- "prefix(github.com/external-secrets/bitwarden-sdk-server)" | ||
- "blank" | ||
- "dot" | ||
goconst: | ||
min-len: 3 | ||
min-occurrences: 3 | ||
gocritic: | ||
enabled-tags: | ||
- diagnostic | ||
- experimental | ||
- opinionated | ||
- performance | ||
- style | ||
disabled-checks: | ||
- dupImport | ||
- ifElseChain | ||
- octalLiteral | ||
- whyNoLint | ||
- wrapperFunc | ||
- importShadow | ||
- unnamedResult | ||
- unnecessaryBlock | ||
settings: | ||
rangeValCopy: | ||
sizeThreshold: 512 | ||
hugeParam: | ||
sizeThreshold: 512 | ||
gocyclo: | ||
min-complexity: 16 | ||
goheader: | ||
template-path: ./hack/boilerplate.go.txt | ||
dupl: | ||
threshold: 200 | ||
govet: | ||
check-shadowing: false | ||
lll: | ||
line-length: 300 | ||
misspell: | ||
locale: US | ||
|
||
linters: | ||
disable-all: true | ||
enable: | ||
- asciicheck | ||
- bodyclose | ||
- dogsled | ||
- dupl | ||
- errcheck | ||
- errorlint | ||
- exhaustive | ||
- exportloopref | ||
- gci | ||
- goheader | ||
- goconst | ||
- gocritic | ||
- godot | ||
- gofmt | ||
- goprintffuncname | ||
- gosec | ||
- gosimple | ||
- govet | ||
- ineffassign | ||
- lll | ||
- misspell | ||
- nakedret | ||
- nolintlint | ||
- prealloc | ||
- staticcheck | ||
- stylecheck | ||
- typecheck | ||
- unconvert | ||
- unparam | ||
- unused | ||
- whitespace | ||
|
||
issues: | ||
# Excluding configuration per-path and per-linter | ||
exclude-rules: | ||
# Exclude some linters from running on tests files. | ||
- path: _test(ing)?\.go | ||
linters: | ||
- gocyclo | ||
- errcheck | ||
- dupl | ||
- gosec | ||
- unparam | ||
- lll | ||
|
||
# Ease some gocritic warnings on test files. | ||
- path: _test\.go | ||
text: "(unnamedResult|exitAfterDefer)" | ||
linters: | ||
- gocritic | ||
|
||
# This is a "potential hardcoded credentials" warning. It's triggered by | ||
# any variable with 'secret' in the same, and thus hits a lot of false | ||
# positives in Kubernetes land where a Secret is an object type. | ||
- text: "G101:" | ||
linters: | ||
- gosec | ||
|
||
# The header check doesn't correctly parse the header as a code comment and is | ||
# triggered by the perceived diff. The header check still correctly detects missing | ||
# license headers and is useful for some cases. | ||
- text: "Actual:" | ||
linters: | ||
- goheader | ||
|
||
# excluding deprecation check introduced on purpose in #2884 | ||
- path: pkg/provider/fake/fake.go | ||
text: 'SA1019: data.ValueMap is deprecated: ValueMap is deprecated and is intended to be removed in the future, use the `value` field instead.' | ||
- path: pkg/provider/fake/fake_test.go | ||
text: 'SA1019: data.ValueMap is deprecated: ValueMap is deprecated and is intended to be removed in the future, use the `value` field instead.' | ||
|
||
# Maximum issues count per one linter. Set to 0 to disable. Default is 50. | ||
max-per-linter: 0 | ||
|
||
# Maximum count of issues with the same text. Set to 0 to disable. Default is 3. | ||
max-same-issues: 0 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,6 @@ | ||
# Contributing | ||
|
||
See the [Developer guide](docs/contributing/devguide.md) for information | ||
about setting up your development environment, and the | ||
[Contributing Process](docs/contributing/process.md) document | ||
for details about the workflow. |
Oops, something went wrong.