Skip to content

Conversation

@miraccan00
Copy link

Hey, I just made a Pull Request!

✔️ Checklist

  • A changeset describing the change and affected packages. (more info)
  • Added or updated documentation
  • Tests for new functionality and regression tests for bug fixes
  • Screenshots attached (for UI changes)
  • All your commits have a Signed-off-by line in the message. (more info)

miraccan00 and others added 8 commits April 10, 2025 02:28
…creation and token generation capabilities - Introduced a new module for integrating SonarQube with Backstage scaffolder. - Added functionality to create SonarQube projects and generate tokens. - Included example configurations and templates for usage. - Implemented TypeScript support and Jest testing for the module. This commit establishes the foundation for SonarQube integration, enhancing the Backstage scaffolder's capabilities for DevOps workflows.

Signed-off-by: Mirac Can Yilmaz <[email protected]>
…space support and configuration files

- Added workspace configuration for the SonarQube module in package.json.
- Introduced ESLint configuration files for code quality enforcement.
- Created Docker Compose setup for local SonarQube instance.
- Added catalog info and README documentation for module usage.
- Implemented TypeScript configuration and example templates for project creation and CI/CD integration.

This commit builds upon the initial SonarQube integration, providing a more comprehensive setup for developers using Backstage scaffolder.

Signed-off-by: Mirac Can Yilmaz <[email protected]>
- Introduced changeset configuration file for versioning and changelog management.
- Added README documentation for the changesets folder to assist developers in using the tool.
- Created a changeset for fixing ESLint and TypeScript configurations, enhancing module resolution and ESM compatibility.

These updates streamline the development process and improve code quality for the SonarQube module.

Signed-off-by: Mirac Can Yilmaz <[email protected]>
- Deleted the ESLint configuration file from the SonarQube module as part of the cleanup process.
- This change simplifies the module's setup and aligns with recent updates to the development workflow.

No functional changes were made to the codebase.

Signed-off-by: Mirac Can Yilmaz <[email protected]>
- Removed legacy SonarQube project creation action and replaced it with a new action that uses shared configuration.
- Introduced `createConfiguredSonarQubeProjectAction` to streamline project creation without passing credentials in templates.
- Updated README to reflect new action usage and configuration.
- Added Docker Compose file for local SonarQube testing.
- Implemented unit and live tests for the new action.
- Enhanced SonarQube client with improved error handling and authorization.
- Updated TypeScript definitions and configuration files to support changes.
@backstage-goalie
Copy link
Contributor

Missing Changesets

The following package(s) are changed by this PR but do not have a changeset:

  • @backstage-community/plugin-scaffolder-backend-module-sonarqube

See CONTRIBUTING.md for more information about how to add changesets.

Changed Packages

Package Name Package Path Changeset Bump Current Version
@backstage-community/plugin-scaffolder-backend-module-sonarqube workspaces/scaffolder-backend-module-sonarqube/plugins/scaffolder-backend-module-sonarqube none v2.10.0

@backstage-goalie
Copy link
Contributor

Thanks for the contribution!
All commits need to be DCO signed before they are reviewed. Please refer to the the DCO section in CONTRIBUTING.md or the DCO status for more info.

@miraccan00
Copy link
Author

This issue was originally developed here , and after receiving some feedback, I made additional changes to the PR and pushed again.

This PR is related to this issue: #2795

I struggled a bit while pushing code to my branch because ESLint threw an error that I couldn’t understand at first. If you notice anything, I can try to fix it. I appreciate your review and look forward to your feedback. Thank you.

@miraccan00 miraccan00 changed the title Sonarqube v2 issue 2795 Merge SonarQube v2 module into the existing scaffolder plugin with a new config-driven action, deprecate the legacy action, and add docs + tests for local SonarQube setups Nov 17, 2025
@miraccan00
Copy link
Author

When I try to run this locally:

yarn build:api-reports:only --ci
Generating package API reports
Processing plugins\scaffolder-backend-module-sonarqube

Error: The API Report for plugins\scaffolder-backend-module-sonarqube is not allowed to have warnings

I get the same error that also appears in one of the pipelines. Is there anything I should look into to fix this?”

@kurtaking
Copy link
Member

kurtaking commented Nov 18, 2025

When I try to run this locally:

yarn build:api-reports:only --ci
Generating package API reports
Processing plugins\scaffolder-backend-module-sonarqube

Error: The API Report for plugins\scaffolder-backend-module-sonarqube is not allowed to have warnings

I get the same error that also appears in one of the pipelines. Is there anything I should look into to fix this?”

@miraccan00 - Open the API report locally and search for the warnings. It's usually a lot clearer on what to do than the feedback in CI. API reports usually fail due to missing or incorrect jsdocs for public facing exports.

@miraccan00
Copy link
Author

When I try to run this locally:

yarn build:api-reports:only --ci
Generating package API reports
Processing plugins\scaffolder-backend-module-sonarqube

Error: The API Report for plugins\scaffolder-backend-module-sonarqube is not allowed to have warnings

I get the same error that also appears in one of the pipelines. Is there anything I should look into to fix this?”

@miraccan00 - Open the API report locally and search for the warnings. It's usually a lot clearer on what to do than the feedback in CI. API reports usually fail due to missing or incorrect jsdocs for public facing exports.

Is there anything I need to do? Thanks for the reply, I really appreciate you taking the time :)

@miraccan00
Copy link
Author

@AndrienkoAleksandr , could you please review my PR when you have a moment?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants