About assets-github-actions-dotnet-sonarcloud

Is a github composite action to run a sonarcloud analysis for dotnet projects

Built With

This section should list any major frameworks that you built your project using. Leave any add-ons/plugins for the acknowledgements section. Here are a few examples.

• Composite action

Features

• sonarcloud analysis for dotnet projects

Getting Started

Check the releases of https://github.com/ERNI-Academy/assets-github-actions-dotnet-sonarcloud/releases Find the lastest tag or one of the previus versions e.g. "v1" Then your able to use it in your workflows

Please take a look at https://docs.github.com/en/actions/creating-actions/creating-a-composite-action to see how composite actions works.

Prerequisites

You would need to have a Sonarcloud Token and the Sonarcloud Project Key. You will have this two values when you configure your repository in sonarcloud. Follow this link https://sonarcloud.io/github to see how to integrate sonarcloud with github.

Remember that Sonarcloud Token is sensitive and should be keeped as a secret.

Installation

In the workflow of your target dotnet repository do this:

1. Your workflow:

jobs:
  build:
    name: Build
    runs-on: windows-latest
    steps:
      - uses: actions/checkout@v3

 #maybe other steps of your desire


     # insert this in order to have sonarcloud analysis:
     - id: sonarcloud
       uses: ERNI-Academy/assets-github-actions-dotnet-sonarcloud@v1  # this is name of the action plus the version "v1" find the lastest tag in the releases
       with:
         sonar_project_key: '[your sonar project key]'  # your project key
         sonar_token: '[your sonar token]'              #your sonarcloud token, we recommend that to storage the token in a secret and use it like ${{ secrets.SONAR_TOKEN }}         
         github_token: ${{ secrets.GITHUB_TOKEN }}

Contributing

Please see our Contribution Guide to learn how to contribute.

License

(LICENSE) © 2022 ERNI - Swiss Software Engineering

Code of conduct

Please see our Code of Conduct

Stats

Check https://repobeats.axiom.co/ for the right URL

Follow us

Contact

📧 esp-services@betterask.erni

Contributors ✨

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!