https://github.com/amancevice/setup-code-climate

Setup Code Climate test reporter binary to use with your GitHub Actions workflows
https://github.com/amancevice/setup-code-climate

Last synced: 4 months ago
JSON representation

Setup Code Climate test reporter binary to use with your GitHub Actions workflows

• Host: GitHub
• URL: https://github.com/amancevice/setup-code-climate
• Owner: amancevice
• License: mit
• Created: 2020-06-07T12:51:50.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2024-03-10T14:29:56.000Z (12 months ago)
• Last Synced: 2024-10-15T13:31:37.085Z (4 months ago)
• Language: JavaScript
• Homepage:
• Size: 432 KB
• Stars: 5
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Setup Code Climate GitHub Action

[![test](https://img.shields.io/github/actions/workflow/status/amancevice/setup-code-climate/test.yaml?logo=github&style=flat-square)](https://github.com/amancevice/setup-code-climate/actions/workflows/test.yaml)

[![coverage](https://img.shields.io/codeclimate/coverage/amancevice/setup-code-climate?logo=code-climate&style=flat-square)](https://codeclimate.com/github/amancevice/setup-code-climate/test_coverage)

[![maintainability](https://img.shields.io/codeclimate/maintainability/amancevice/setup-code-climate?logo=code-climate&style=flat-square)](https://codeclimate.com/github/amancevice/setup-code-climate/maintainability)

Setup `cc-test-reporter` binary to use with your GitHub Actions workflows.

This action [uses itself](./.github/workflows/test.yaml) to run its test suite.

```yaml

- uses: amancevice/setup-code-climate@v2

  with:

    cc_test_reporter_id: ${{ secrets.CC_TEST_REPORTER_ID }}

- run: cc-test-reporter before-build

# ...

- run: cc-test-reporter after-build

```

You may wish to disable the `after-build` step if your workflow is configured to trigger on `pull_request` events.

Your GitHub secrets will not be available to users submitting pull requests from outside your organization and the command will surely fail.

```yaml

- run: cc-test-reporter after-build

  if: ${{ github.event_name != 'pull_request' }}

```