Skip to content

BUILD-5296 doc isDummyProject option#324

Merged
julien-carsique-sonarsource merged 1 commit intomasterfrom
doc/jcarsique/BUILD-5296-readme
Jun 19, 2025
Merged

BUILD-5296 doc isDummyProject option#324
julien-carsique-sonarsource merged 1 commit intomasterfrom
doc/jcarsique/BUILD-5296-readme

Conversation

@julien-carsique-sonarsource
Copy link
Copy Markdown
Contributor

@julien-carsique-sonarsource julien-carsique-sonarsource commented Jun 19, 2025

Move isDummyProject documentation from code comment to the readme.

Copilot AI review requested due to automatic review settings June 19, 2025 13:33
@julien-carsique-sonarsource julien-carsique-sonarsource requested a review from a team as a code owner June 19, 2025 13:33
Copy link
Copy Markdown

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.

Pull Request Overview

This PR adds a new isDummyProject flag to the SonarSource release workflow to allow dummy projects to be treated differently in monitoring and metrics.

  • Documents isDummyProject in the README.md with explanatory notes.
  • Adds the isDummyProject input parameter in .github/workflows/main.yaml with its type, default, and description.

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.

File Description
README.md Added isDummyProject under workflow inputs and a notes section entry.
.github/workflows/main.yaml Introduced isDummyProject input with type, default value, and description.
Comments suppressed due to low confidence (3)

README.md:50

  • [nitpick] Indent the second line of this bullet to align with other notes and consider wrapping the long sentence for better readability.
- `isDummyProject`: The _dummy_ projects are treated differently regarding alerts and metrics. E.g.: in Datadog, the stats from dummy

.github/workflows/main.yaml:94

  • [nitpick] Align this description with the README by mentioning how setting isDummyProject affects monitoring (e.g., exclusion from dashboards).
        description: Indicate whether this is a dummy project.

.github/workflows/main.yaml:91

  • [nitpick] Remove these commented-out legacy lines now that the input has an explicit description to reduce clutter.
        required: false

@sonarqubecloud
Copy link
Copy Markdown

@julien-carsique-sonarsource julien-carsique-sonarsource enabled auto-merge (rebase) June 19, 2025 13:35
@julien-carsique-sonarsource julien-carsique-sonarsource merged commit 1acdd48 into master Jun 19, 2025
15 checks passed
@julien-carsique-sonarsource julien-carsique-sonarsource deleted the doc/jcarsique/BUILD-5296-readme branch June 19, 2025 13:37
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.

3 participants