This custom action needs to be added at step level in a job to register sonar details in ServiceNow instance.

• credentials (username and password for a ServiceNow devops integration user)
• instance URL for your ServiceNow dev, test, prod, etc. environments
• tool_id of your GitHub tool created in ServiceNow DevOps
• sonar URL for your SonarQube instance or Sonar Cloud, for example https://sonarcloud.io
• sonar project the key for your project in Sonar instance, for example org.examples:demo

On GitHub, go in your organization settings or repository settings, click on the Secrets > Actions and create a new secret.

Create secrets called

• SN_DEVOPS_USER
• SN_DEVOPS_PASSWORD
• SN_INSTANCE_URL your ServiceNow instance URL, for example https://test.service-now.com
• SN_ORCHESTRATION_TOOL_ID only the sys_id is required for the GitHub tool created in your ServiceNow instance
• SONAR_URL the URL of your Sonar instance, for example https://sonarcloud.io
• SONAR_PROJECT_KEY the project key in your Sonar instance, for example org.examples:demo

build:
    name: Build
    runs-on: ubuntu-latest
    steps:
      - name: ServiceNow DevOps Sonar Scan Results
        uses: ServiceNow/servicenow-devops-sonar@v1
        with:
          devops-integration-user-name: ${{ secrets.SN_DEVOPS_USER }}
          devops-integration-user-password: ${{ secrets.SN_DEVOPS_PASSWORD }}
          instance-url: ${{ secrets.SN_INSTANCE_URL }}
          tool-id: ${{ secrets.SN_ORCHESTRATION_TOOL_ID }}
          context-github: ${{ toJSON(github) }}
          job-name: 'Build'
          sonar-host-url: ${{ secrets.SONAR_URL }}
          sonar-project-key: ${{ secrets.SONAR_PROJECT_KEY }}

The values for secrets should be setup in Step 1. Secrets should be created in Step 2. The Step Name should be ServiceNow DevOps Sonar Scan Results.

Required DevOps Integration Username to ServiceNow instance.

Required DevOps Integration User Password to ServiceNow instance.

Required URL of ServiceNow instance to register the sonar details, for example https://test.service-now.com.

Required Orchestration Tool Id for GitHub created in ServiceNow DevOps

Required Github context contains information about the workflow run details.

Required Display name of the job given for attribute name in which steps have been added for ServiceNow sonar custom action.

Required URL of SonarQube server instance or Sonar Cloud, for example https://sonarcloud.io.

Required The project key in your Sonar instance URL.

No outputs produced.

ServiceNow customers may request support through the Now Support (HI) portal.

Initially, ServiceNow product management and engineering representatives will own governance of these integrations to ensure consistency with roadmap direction. In the longer term, we hope that contributors from customers and our community developers will help to guide prioritization and maintenance of these integrations. At that point, this governance model can be updated to reflect a broader pool of contributors and maintainers.