[FEATURE] Add CodeClimate coverage report

Đang mở
#10 1 bình luận 1 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
35/100
Loại issue
Tính năng
Độ rõ ràng
Khá rõ ràng
Mức độ hoạt động
Đình trệ
Công nghệ
powershell, yaml
Lĩnh vực
ci-cd, devops, testing-qa

Hướng nghiên cứu

Bắt đầu bằng cách kiểm tra appveyor.yml và các bước test và coverage hiện có, sau đó so sánh chúng với tài liệu về Code Climate coverage reporter được liên kết trong issue. Công việc được xem là hoàn tất khi bản build AppVeyor gửi một báo cáo coverage sau mỗi lần build và repository ghi lại phần thiết lập và cấu hình cần thiết.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

♻️ code quality CI enhancement gitauto github_actions good first issue help wanted

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.

Ngôn ngữ chính
PowerShell
Star
5
Fork
1
Chỉ số merge pull request
Không có pull request nào được merge trong 30 ngày

Chuẩn bị môi trường

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của guibranco/MSBuild.Version.Target

Tất cả issue của guibranco/MSBuild.Version.Target

Issue tương tự

Thêm issue về DevOps

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.