https://github.com/marcospereira/kotlin-detekt-orb

An CircleCI Orb that installs detekt
https://github.com/marcospereira/kotlin-detekt-orb

Last synced: 25 days ago
JSON representation

An CircleCI Orb that installs detekt

• Host: GitHub
• URL: https://github.com/marcospereira/kotlin-detekt-orb
• Owner: marcospereira
• License: mit
• Created: 2024-02-22T02:18:31.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-07-30T15:16:50.000Z (3 months ago)
• Last Synced: 2024-07-30T19:11:04.917Z (3 months ago)
• Language: Shell
• Size: 13.7 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Kotlin detekt orb

[![CircleCI Build Status](https://circleci.com/gh/marcospereira/kotlin-detekt-orb.svg?style=shield "CircleCI Build Status")](https://circleci.com/gh/marcospereira/kotlin-detekt-orb) [![CircleCI Orb Version](https://badges.circleci.com/orbs/marcospereira/kotlin-detekt-orb.svg)](https://circleci.com/developer/orbs/orb/marcospereira/kotlin-detekt-orb) [![GitHub License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/marcospereira/kotlin-detekt-orb/master/LICENSE) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/orbs)

This orb provides a set of commands and jobs to lint Kotlin code using [detekt](https://detekt.github.io/detekt/).

---

## Resources

[CircleCI Orb Registry Page](https://circleci.com/developer/orbs/orb/marcospereira/kotlin-detekt-orb) - The official registry page of this orb for all versions, executors, commands, and jobs described.

[CircleCI Orb Docs](https://circleci.com/docs/orb-intro/#section=configuration) - Docs for using, creating, and publishing CircleCI Orbs.

### How to Contribute

We welcome [issues](https://github.com/marcospereira/kotlin-detekt-orb/issues) to and [pull requests](https://github.com/marcospereira/kotlin-detekt-orb/pulls) against this repository!

### How to Publish An Update

1. Merge pull requests with desired changes to the main branch.

    - For the best experience, squash-and-merge and use [Conventional Commit Messages](https://conventionalcommits.org/).

2. Find the current version of the orb.

    - You can run `circleci orb info marcospereira/kotlin-detekt-orb | grep "Latest"` to see the current version.

3. Create a [new Release](https://github.com/marcospereira/kotlin-detekt-orb/releases/new) on GitHub.

    - Click "Choose a tag" and _create_ a new [semantically versioned](http://semver.org/) tag. (ex: v1.0.0)

      - We will have an opportunity to change this before we publish if needed after the next step.

4.  Click _"+ Auto-generate release notes"_.

    - This will create a summary of all of the merged pull requests since the previous release.

    - If you have used _[Conventional Commit Messages](https://conventionalcommits.org/)_ it will be easy to determine what types of changes were made, allowing you to ensure the correct version tag is being published.

5. Now ensure the version tag selected is semantically accurate based on the changes included.

6. Click _"Publish Release"_.

    - This will push a new tag and trigger your publishing pipeline on CircleCI.