https://github.com/remarkablemark/setup-codeclimate
⚙️ Set up GitHub Actions workflow with Code Climate test reporter
https://github.com/remarkablemark/setup-codeclimate
action cli codeclimate codeclimate-cli codeclimate-coverage codeclimate-report github-action github-actions workflow
Last synced: 2 months ago
JSON representation
⚙️ Set up GitHub Actions workflow with Code Climate test reporter
- Host: GitHub
- URL: https://github.com/remarkablemark/setup-codeclimate
- Owner: remarkablemark
- License: mit
- Created: 2023-05-06T20:28:04.000Z (about 2 years ago)
- Default Branch: master
- Last Pushed: 2024-10-30T02:40:45.000Z (7 months ago)
- Last Synced: 2024-10-30T05:08:43.240Z (7 months ago)
- Topics: action, cli, codeclimate, codeclimate-cli, codeclimate-coverage, codeclimate-report, github-action, github-actions, workflow
- Language: TypeScript
- Homepage: https://b.remarkabl.org/setup-codeclimate
- Size: 1.45 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# setup-codeclimate
[](https://github.com/remarkablemark/setup-codeclimate/releases)
[](https://github.com/remarkablemark/setup-codeclimate/actions/workflows/build.yml)
[](https://codeclimate.com/github/remarkablemark/setup-codeclimate/maintainability)
[](https://codeclimate.com/github/remarkablemark/setup-codeclimate/test_coverage)
⚙️ Set up your GitHub Actions workflow with [Code Climate test reporter](https://github.com/codeclimate/test-reporter).
## Quick Start
```yaml
name: test
on: push
jobs:
test:
runs-on: ubuntu-latest
steps:
- name: Setup Code Climate
uses: remarkablemark/setup-codeclimate@v2
- name: Run Test and Upload Coverage
run: |
cc-test-reporter before-build
# insert your test command here
cc-test-reporter after-build --exit-code $?
env:
CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
```
## Usage
See [action.yml](action.yml)
**Basic:**
```yaml
- uses: remarkablemark/setup-codeclimate@v2
```
**Example:**
```yaml
- uses: remarkablemark/setup-codeclimate@v2
- run: |
cc-test-reporter before-build
npm test
cc-test-reporter after-build --exit-code $?
env:
CC_TEST_REPORTER_ID: ${{ secrets.CC_TEST_REPORTER_ID }}
```
## Inputs
### `codeclimate-version`
**Optional**: The Code Climate test reporter [version](https://github.com/codeclimate/test-reporter/releases). Defaults to `latest`:
```yaml
- uses: remarkablemark/setup-codeclimate@v2
with:
codeclimate-version: 0.11.1
```
### `cli-name`
**Optional**: The Code Climate test reporter CLI name. Defaults to `cc-test-reporter`:
```yaml
- uses: remarkablemark/setup-codeclimate@v2
with:
cli-name: cc-test-reporter
```
## Examples
- [remarkablemark/codeclimate-github-actions-examples](https://github.com/remarkablemark/codeclimate-github-actions-examples)
## Contributions
👋 Contributions are welcome!
## License
[MIT](LICENSE)