Adjust project files and configurations

Fyusel · Fyusel · commit 7a92b6c62f27 · 2025-07-18T11:54:01.000+02:00
Signed-off-by: Alexander Dahmen &lt;alexander.dahmen@inovex.de&gt;
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -1,6 +1,6 @@
 ---
 name: Bug report
-about: Report a bug in the STACKIT pulumi provider
+about: Report a bug in the STACKIT Pulumi Provider
 title: ''
 labels: bug
 assignees: ''
@@ -26,16 +26,17 @@ assignees: ''
 
 ## Actual behavior
 
-*Please describe the current behavior of the STACKIT pulumi provider. Don't forget to add detailed information like error messages.*
+*Please describe the current behavior of the STACKIT Pulumi Provider. Don't forget to add detailed information like error messages.*
 
 ## Expected behavior
 
-*Please describe the behavior which you would expect from the STACKIT pulumi provider in that case.*
+*Please describe the behavior which you would expect from the STACKIT Pulumi Provider in that case.*
 
 ## Environment
  - OS: 
- - pulumi version (see `pulumi --version`): `vX.X.X` 
- - Version of the STACKIT pulumi provider: `vX.X.X`
+ - pulumi version (see `pulumi version`): `vX.X.X` 
+ - pulumictl version (see `pulumictl version`) `X.X.X`
+ - Version of the STACKIT Pulumi Provider: `vX.X.X`
 
 **Additional information**
 
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -1,6 +1,6 @@
 ---
 name: Feature request
-about: Suggest an idea for the STACKIT pulumi provider
+about: Suggest an idea for the STACKIT Pulumi Provider
 title: ''
 labels: enhancement
 assignees: ''
diff --git a/.golangci.yml b/.golangci.yml
@@ -1,24 +1,95 @@
+# This file contains all available configuration options
+# with their default values.
+
+# options for analysis running
+run:
+  # default concurrency is a available CPU number
+  concurrency: 4
+
+  # timeout for analysis, e.g. 30s, 5m, default is 1m
+  timeout: 5m
+linters-settings:
+  goimports:
+    # put imports beginning with prefix after 3rd-party packages;
+    # it's a comma-separated list of prefixes
+    local-prefixes: github.com/freiheit-com/nmww
+  depguard:
+    rules:
+      main:
+        list-mode: lax # Everything is allowed unless it is denied
+        deny:
+          - pkg: "github.com/stretchr/testify"
+            desc: Do not use a testing framework
+  misspell:
+    # Correct spellings using locale preferences for US or UK.
+    # Default is to use a neutral variety of English.
+    # Setting locale to US will correct the British spelling of 'colour' to 'color'.
+    locale: US
+  golint:
+    min-confidence: 0.8
+  gosec:
+    excludes:
+    # Suppressions: (see https://github.com/securego/gosec#available-rules for details)
+      - G104 # "Audit errors not checked" -> which we don't need and is a badly implemented version of errcheck
+      - G102 # "Bind to all interfaces" -> since this is normal in k8s
+      - G304 # "File path provided as taint input" -> too many false positives
+      - G307 # "Deferring unsafe method "Close" on type "io.ReadCloser" -> false positive when calling defer resp.Body.Close()
+  nakedret:
+    max-func-lines: 0
+  revive:
+    ignore-generated-header: true
+    severity: error
+    # https://github.com/mgechev/revive
+    rules:
+      - name: errorf
+      - name: context-as-argument
+      - name: error-return
+      - name: increment-decrement
+      - name: indent-error-flow
+      - name: superfluous-else
+      - name: unused-parameter
+      - name: unreachable-code
+      - name: atomic
+      - name: empty-lines
+      - name: early-return
+  gocritic:
+    enabled-tags:
+      - performance
+      - style
+      - experimental
+    disabled-checks:
+      - wrapperFunc
+      - typeDefFirst
+      - ifElseChain
+      - dupImport # https://github.com/go-critic/go-critic/issues/845
 linters:
   enable:
-    - deadcode
-    - errcheck
-    - goconst
-    - gofmt
-    - golint
-    - gosec
+    # https://golangci-lint.run/usage/linters/
+    # default linters
+    - gosimple
     - govet
     - ineffassign
-    - interfacer
-    - lll
-    - megacheck
+    - staticcheck
+    - typecheck
+    - unused
+    # additional linters
+    - errorlint
+    - gochecknoinits
+    - gocritic
+    - gofmt
+    - goimports
+    - gosec
     - misspell
     - nakedret
-    - structcheck
-    - unconvert
-    - varcheck
-  enable-all: false
-run:
-  skip-files:
-    - schema.go
-    - pulumiManifest.go
-  timeout: 20m
+    - revive
+    - depguard
+    - bodyclose
+    - sqlclosecheck
+    - wastedassign
+    - forcetypeassert
+    - errcheck
+  disable:
+    - noctx # false positive: finds errors with http.NewRequest that dont make sense
+    - unparam # false positives
+issues:
+  exclude-use-default: false
diff --git a/CODE-OF-CONDUCT.md b/CODE-OF-CONDUCT.md
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
diff --git a/CONTRIBUTION.md b/CONTRIBUTION.md
@@ -0,0 +1,51 @@
+# Contribute to the STACKIT Pulumi Provider
+
+Your contribution is welcome! Thank you for your interest in contributing to the STACKIT Pulumi Provider. We greatly value your feedback, feature requests, additions to the code, bug reports or documentation extensions.
+
+## Table of contents
+
+- [Developer Guide](#developer-guide)
+- [Useful Make commands](#useful-make-commands)
+- [Code Contributions](#code-contributions)
+- [Bug Reports](#bug-reports)
+
+
+## Developer Guide
+
+Prerequisites:
+
+- [`Pulumi`](https://www.pulumi.com/docs/iac/download-install/)
+- [`pulumictl`](https://github.com/pulumi/pulumictl)
+- [`Go`](https://go.dev/doc/install) 1.23+
+
+### Useful Make commands
+
+These commands can be executed from the project root:
+
+- `make build`: command to compile and install everything which is needed
+- `make tfgen`: installs the provider plugins
+- `make generate_sdks`: generates the sdks for all languages
+- `make lint_provider`: lint the provider code
+- `make fmt`: run code formatter
+
+## Code Contributions
+
+To make your contribution, follow these steps:
+
+1. Check open or recently closed [Pull Requests](https://github.com/stackitcloud/pulumi-stackit/pulls) and [Issues](https://github.com/stackitcloud/pulumi-stackit/issues) to make sure the contribution you are making has not been already tackled by someone else.
+2. Fork the repo.
+3. Make your changes in a branch that is up-to-date with the original repo's `main` branch.
+4. Commit your changes including a descriptive message
+5. Create a pull request with your changes.
+6. The pull request will be reviewed by the repo maintainers. If you need to make further changes, make additional commits to keep commit history. When the PR is merged, commits will be squashed.
+
+## Bug Reports
+
+If you would like to report a bug, please open a [GitHub issue](https://github.com/stackitcloud/pulumi-stackit/issues/new).
+
+To ensure we can provide the best support to your issue, follow these guidelines:
+
+1. Go through the existing issues to check if your issue has already been reported.
+2. Make sure you are using the latest version of the STACKIT Pulumi Provider, we will not provide bug fixes for older versions. Also, latest versions may have the fix for your bug.
+3. Please provide as much information as you can about your environment, e.g. your versions used, your version of the STACKIT Pulumi Provider, which operating system you are using and the corresponding version.
+4. Include in your issue the steps to reproduce it, along with code snippets and/or information about your specific use case. This will make the support process much easier and efficient.
diff --git a/Makefile b/Makefile
@@ -140,3 +140,5 @@ install_sdks:: install_dotnet_sdk install_python_sdk install_nodejs_sdk
 test::
 	cd examples && go test -v -tags=all -parallel ${TESTPARALLELISM} -timeout 2h
 
+fmt:
+	@gofmt -s -w .
diff --git a/README.md b/README.md
@@ -1,8 +1,10 @@
-# STACKIT Resource Provider
+# STACKIT Pulumi Provider (BETA)
 
 ![logo.svg](docs/logo.svg)
 
-The STACKIT Resource Provider lets you manage [STACKIT](https://www.stackit.de/en/) resources.
+The STACKIT Pulumi Provider lets you manage [STACKIT](https://www.stackit.de/en/) resources.
+
+This STACKIT Pulumi Provider is in a BETA state. More functionality will be supported soon. Your feedback is appreciated! Feel free to open GitHub issues to provide feature requests and bug reports.
 
 ## Installing
 
@@ -52,7 +54,6 @@ The following configuration points are available for the `stackit` provider:
 
 | Configuration Variable | Environment Variable | Description |
 |------------------------|---------------------|-------------|
-| `stackit:argusCustomEndpoint` | `STACKIT_ARGUS_CUSTOM_ENDPOINT` | Custom endpoint for the Argus service ⚠️ **Deprecated**: Argus service has been deprecated and integration will be removed after February 26th 2025. Please use `observability_custom_endpoint` and `observability` resources instead |
 | `stackit:authorizationCustomEndpoint` | `STACKIT_AUTHORIZATION_CUSTOM_ENDPOINT` | Custom endpoint for the Membership service |
 | `stackit:cdnCustomEndpoint` | `STACKIT_CDN_CUSTOM_ENDPOINT` | Custom endpoint for the CDN service |
 | `stackit:credentialsPath` | `STACKIT_CREDENTIALS_PATH` | Path of JSON from where the credentials are read. Default value is `~/.stackit/credentials.json` |
diff --git a/provider/cmd/pulumi-resource-stackit/main.go b/provider/cmd/pulumi-resource-stackit/main.go
@@ -19,8 +19,9 @@ package main
 import (
 	"context"
 	_ "embed"
-	stackit "github.com/stackitcloud/pulumi-stackit/provider"
+
 	"github.com/pulumi/pulumi-terraform-bridge/v3/pkg/pf/tfbridge"
+	stackit "github.com/stackitcloud/pulumi-stackit/provider"
 )
 
 //go:embed schema-embed.json
diff --git a/provider/cmd/pulumi-tfgen-stackit/main.go b/provider/cmd/pulumi-tfgen-stackit/main.go
@@ -15,8 +15,8 @@
 package main
 
 import (
-	stackit "github.com/stackitcloud/pulumi-stackit/provider"
 	"github.com/pulumi/pulumi-terraform-bridge/v3/pkg/pf/tfgen"
+	stackit "github.com/stackitcloud/pulumi-stackit/provider"
 )
 
 func main() {
diff --git a/provider/resources.go b/provider/resources.go
diff --git a/provider/shim/shim.go b/provider/shim/shim.go

Original file line number	Diff line number	Diff line change
`@@ -15,8 +15,8 @@`
`15`	`15`	`package main`
`16`	`16`
`17`	`17`	`import (`
`18`		`- stackit "github.com/stackitcloud/pulumi-stackit/provider"`
`19`	`18`	`"github.com/pulumi/pulumi-terraform-bridge/v3/pkg/pf/tfgen"`
	`19`	`+ stackit "github.com/stackitcloud/pulumi-stackit/provider"`
`20`	`20`	`)`
`21`	`21`
`22`	`22`	`func main() {`