https://github.com/kolosovpetro/sonarcloudviagithubactions

Explains how to integrate SonarCloud with GitHub actions in a simple and quick approach.
https://github.com/kolosovpetro/sonarcloudviagithubactions

continuous-integration github-actions sonarcloud sonarqube

Last synced: about 1 month ago
JSON representation

Explains how to integrate SonarCloud with GitHub actions in a simple and quick approach.

• Host: GitHub
• URL: https://github.com/kolosovpetro/sonarcloudviagithubactions
• Owner: kolosovpetro
• License: mit
• Created: 2022-05-30T19:58:25.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-10-31T17:48:42.000Z (about 2 years ago)
• Last Synced: 2024-10-12T21:47:16.702Z (3 months ago)
• Topics: continuous-integration, github-actions, sonarcloud, sonarqube
• Language: TeX
• Homepage: https://kolosovpetro.github.io/pdf/SonarCloudViaGithubActions.pdf
• Size: 2.35 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# SonarCloud via GitHub Actions

Explains how to integrate SonarCloud with GitHub actions in a simple and quick approach.

## Build and run in Intellij IDEA

- Install `MikTeX`: https://miktex.org/download

- Update `MikTeX`

- Install `SumatraPDF` viewer: https://www.sumatrapdfreader.org/download-free-pdf-viewer

- Install `Intellij IDEA Ultimate`: https://www.jetbrains.com/idea/download/#section=windows

- Activate `Intellij IDEA Ultimate`

- Install `TeXiFy IDEA` plugin: https://plugins.jetbrains.com/plugin/9473-texify-idea

- Clone this repository locally: `https://github.com/kolosovpetro/SonarCloudViaGithubActions.git`

- Open `github-latex-template` folder in `Intellij IDEA Ultimate` and configure as follows

    - LaTeX Configuration

      ![LaTeX Configuration](img/latex_configuration.PNG?raw=true "LaTeX Configuration")

    - BibTeX Configuration

      ![BibTeX Configuration](img/bibtex_configuration.PNG?raw=true "BibTeX Configuration")

- Configure Inverse Search in `Intellij IDEA` for SumatraPDF: `Tools -> LaTeX -> Configure Inverse Search`

- Compile document using `Shift + F10`

## Configure CI / CD

Set repository secrets

- `GH_ACCESS_TOKEN`: Generate GitHub Personal access token at

  `Settings -> Developer Settings -> Personal access tokens -> Generate mew token` and assign in to

  secret `GH_ACCESS_TOKEN`

## Actions and their trigger policy

- `build-pdf.yml` builds project using `TeXLive`. Triggered on `pull_request`, `push` to `develop` branch

- `build-and-deploy-pdf.yml` builds project using `TeXLive` and deploys to `GitHub Pages`. Triggered on `push` to `main`

  branch

## Template example

Compiled document looks like as follows