Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/ERNI-Academy/assets-github-actions-dotnet-sonarcloud

github composite action for sonarcloud analysis
https://github.com/ERNI-Academy/assets-github-actions-dotnet-sonarcloud

dotnet github-actions sonarcloud

Last synced: 3 months ago
JSON representation

github composite action for sonarcloud analysis

Awesome Lists containing this project

README

        

# 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](https://docs.github.com/en/actions/creating-actions/creating-a-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:

```yml
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](CONTRIBUTING.md) to learn how to contribute.

## License

![MIT](https://img.shields.io/badge/License-MIT-blue.svg)

(LICENSE) © 2022 [ERNI - Swiss Software Engineering](https://www.betterask.erni)

## Code of conduct

Please see our [Code of Conduct](CODE_OF_CONDUCT.md)

## Stats

Check [https://repobeats.axiom.co/](https://repobeats.axiom.co/) for the right URL

## Follow us

[![Twitter Follow](https://img.shields.io/twitter/follow/ERNI?style=social)](https://www.twitter.com/ERNI)
[![Twitch Status](https://img.shields.io/twitch/status/erni_academy?label=Twitch%20Erni%20Academy&style=social)](https://www.twitch.tv/erni_academy)
[![YouTube Channel Views](https://img.shields.io/youtube/channel/views/UCkdDcxjml85-Ydn7Dc577WQ?label=Youtube%20Erni%20Academy&style=social)](https://www.youtube.com/channel/UCkdDcxjml85-Ydn7Dc577WQ)
[![Linkedin](https://img.shields.io/badge/linkedin-31k-green?style=social&logo=Linkedin)](https://www.linkedin.com/company/erni)

## Contact

📧 [[email protected]](mailto:[email protected])

## Contributors ✨

Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/docs/en/emoji-key)):

This project follows the [all-contributors](https://github.com/all-contributors/all-contributors) specification. Contributions of any kind welcome!