Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: document the config file #194

Open
wants to merge 17 commits into
base: develop
Choose a base branch
from

Conversation

vcastellm
Copy link
Contributor

@vcastellm vcastellm commented Nov 19, 2024

Add documentation to config file

  • Text is copied from the original Go comment in config.go when existing

@Stefan-Ethernal Stefan-Ethernal changed the title doc: document part of the config file docs: document part of the config file Nov 19, 2024
@vcastellm vcastellm requested a review from Copilot November 21, 2024 10:30
Copy link

@Copilot Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 5 out of 6 changed files in this pull request and generated 1 suggestion.

Files not reviewed (1)
  • crates/cdk/src/main.rs: Evaluated as low risk
Comments skipped due to low confidence (1)

config/default.go:3

  • The comment contains spelling errors. 'This' should be 'These' and 'doesnt' should be 'doesn't'.
// This values doesnt have a default value because depend on the environment / deployment

config/default.go Outdated Show resolved Hide resolved
@vcastellm vcastellm marked this pull request as ready for review November 21, 2024 15:06
@vcastellm vcastellm changed the title docs: document part of the config file docs: document the config file Nov 21, 2024
config/default.go Outdated Show resolved Hide resolved
Copy link
Contributor

@rachit77 rachit77 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

Copy link
Collaborator

@Stefan-Ethernal Stefan-Ethernal left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Generally LGTM

config/default.go Outdated Show resolved Hide resolved
config/default.go Outdated Show resolved Hide resolved
config/default.go Outdated Show resolved Hide resolved
config/default.go Outdated Show resolved Hide resolved
config/default.go Outdated Show resolved Hide resolved
config/default.go Outdated Show resolved Hide resolved
config/default.go Outdated Show resolved Hide resolved
config/default.go Outdated Show resolved Hide resolved
@vcastellm vcastellm requested a review from Copilot November 25, 2024 11:53

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copilot reviewed 6 out of 9 changed files in this pull request and generated no suggestions.

Files not reviewed (3)
  • crates/cdk/versions.json: Language not supported
  • cmd/config.go: Evaluated as low risk
  • crates/cdk-config/src/aggregator.rs: Evaluated as low risk
Copy link

sonarqubecloud bot commented Dec 9, 2024

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants