Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[FEATURE] Add Code Climate coverage report #9

Open
guibranco opened this issue Apr 8, 2023 · 0 comments
Open

[FEATURE] Add Code Climate coverage report #9

guibranco opened this issue Apr 8, 2023 · 0 comments
Labels
CI code quality enhancement New feature or request gitauto github_actions Pull requests that update GitHub Actions code good first issue Good for newcomers help wanted Extra attention is needed

Comments

@guibranco
Copy link
Owner

guibranco commented Apr 8, 2023

Description
We need to integrate Code Climate into our CI/CD pipeline to generate coverage reports for our project. This integration will help us maintain code quality and provide insights into our test coverage over time.

Context
The current configuration for our AppVeyor build can be found here. We need to update this configuration to include Code Climate coverage reporting.

Resources

Acceptance Criteria

  • Code Climate should be integrated into our build process.
  • Coverage reports should be sent to Code Climate after each build.
  • The setup should be documented in the repository.

Proposed Solution

  1. Create a Code Climate Token
    Sign up or log in to Code Climate, create a new repository, and obtain your repository token.

  2. Update AppVeyor Configuration
    Modify the appveyor.yml file to include the necessary steps for Code Climate integration. Below is a sample configuration snippet:

    # appveyor.yml
    version: '{build}'
    configuration: Release
    platform:
      - x64
    
    before_build:
      - nuget restore
    
    build_script:
      - msbuild /p:Configuration=Release
    
    after_test:
      - dotnet tool install --global dotnet-reportgenerator-globaltool
      - reportgenerator -reports:./Tests/coverage.cobertura.xml -targetdir:./Tests/coverage-report -reporttypes:Html
      - curl -X POST -H "Content-Type: application/json" -d "{\"data\":{\"attributes\":{\"branch\":\"$APPVEYOR_REPO_BRANCH\",\"commit\":\"$APPVEYOR_REPO_COMMIT\",\"coverage\":\"$(cat ./Tests/coverage-report/coverage.cobertura.xml)\"}}}" "https://api.codeclimate.com/v1/test_reports?project_id=<your_project_id>" -H "Authorization: Token <your_code_climate_token>"

    Replace <your_project_id> and <your_code_climate_token> with your actual Code Climate project ID and token.

  3. Install Required Tools
    Ensure that the dotnet-reportgenerator-globaltool is installed to generate the coverage reports.

  4. Verify Integration
    Push your changes and verify that the Code Climate coverage report is correctly uploaded after each build.

Additional Context
Make sure you have your Code Climate project set up and that you have the necessary permissions to push coverage reports. This integration will enable continuous monitoring of our code quality.

@guibranco guibranco self-assigned this Apr 20, 2023
@guibranco guibranco added code quality github_actions Pull requests that update GitHub Actions code CI labels Jun 22, 2023
@guibranco guibranco added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Jun 30, 2023
@guibranco guibranco removed their assignment Jun 30, 2023
@guibranco guibranco changed the title Add CodeClimate coverage report Add Code Climate coverage report Jul 4, 2023
@guibranco guibranco changed the title Add Code Climate coverage report [FEATURE] Add Code Climate coverage report May 15, 2024
@gitauto-ai gitauto-ai bot added the gitauto label Jul 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI code quality enhancement New feature or request gitauto github_actions Pull requests that update GitHub Actions code good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

1 participant