feat: initial orb release [semver:major]

Author: KyleTryon

.circleci/config.yml

@@ -4,8 +4,9 @@ orbs:
   # Replace this with your own!
   commitlint: conventional-changelog/commitlint@<<pipeline.parameters.dev-orb-version>>
   orb-tools: circleci/[email protected]
-  bats: circleci/[email protected]
   shellcheck: circleci/[email protected]
+  bats: circleci/[email protected]
+  node: circleci/[email protected]
 
 # Pipeline Parameters
 ## These parameters are used internally by orb-tools. Skip to the Jobs section.
@@ -22,18 +23,6 @@ parameters:
     type: string
     default: "dev:alpha"
 
-jobs:
-  # Define one or more jobs which will utilize your orb's commands and parameters to validate your changes.
-  integration-test-1:
-    docker:
-      - image: cimg/base:stable
-    steps:
-      - checkout
-      # "greet" is a sample command packaged with this orb config.
-      # This sample integration test will run as long as the greet command exists. Once you remove the greet command you should remove this line.
-      # Push new changes first, before adding new tests to your config.
-      - commitlint/greet
-
 workflows:
   # Prior to producing a development orb (which requires credentials) basic validation, linting, and even unit testing can be performed.
   # This workflow will run on every commit
@@ -45,51 +34,47 @@ workflows:
       - shellcheck/check:
           dir: ./src/scripts
           exclude: SC2148
-      # optional: Run BATS tests against your scripts
       - bats/run:
+          exec_environment: node/default
           path: ./src/tests
+          pre-steps:
+            - run:
+                name: Git Config
+                command: |
+                  mkdir -p ~/.config/yarn
+                  sudo chown -R circleci ~/.config/
+                  sudo chgrp -R circleci ~/.config/
+                  git config --global user.email "[email protected]"
+                  git config --global user.name "CPE Team"
       # Publish development version(s) of the orb.
       - orb-tools/publish-dev:
           orb-name: conventional-changelog/commitlint
           context: orb-publishing # A restricted context containing your private publishing credentials. Will only execute if approved by an authorized user.
           requires:
             - orb-tools/lint
             - orb-tools/pack
-            - bats/run
             - shellcheck/check
+            - bats/run
       # Trigger an integration workflow to test the
       # dev:${CIRCLE_SHA1:0:7} version of your orb
       - orb-tools/trigger-integration-tests-workflow:
           name: trigger-integration-dev
           context: orb-publishing
           requires:
             - orb-tools/publish-dev
-
-  # This `integration-test_deploy` workflow will only run
-  # when the run-integration-tests pipeline parameter is set to true.
-  # It is meant to be triggered by the "trigger-integration-tests-workflow"
-  # job, and run tests on <your orb>@dev:${CIRCLE_SHA1:0:7}.
   integration-test_deploy:
     when: << pipeline.parameters.run-integration-tests >>
     jobs:
-      # Run any integration tests defined within the `jobs` key.
-      - integration-test-1
-      # Publish a semver version of the orb. relies on
-      # the commit subject containing the text "[semver:patch|minor|major|skip]"
-      # as that will determine whether a patch, minor or major
-      # version will be published or if publishing should
-      # be skipped.
-      # e.g. [semver:patch] will cause a patch version to be published.
+      - commitlint/lint
       - orb-tools/dev-promote-prod-from-commit-subject:
           orb-name: conventional-changelog/commitlint
           context: orb-publishing
           add-pr-comment: false
           fail-if-semver-not-indicated: true
           publish-version-tag: false
           requires:
-            - integration-test-1
+            - commitlint/lint
           filters:
             branches:
               only:
-                - master
                 - main

.gitignore

@@ -1,2 +1,3 @@
 # orb.yml is "packed" from source, and not published directly from the repository.
-orb.yml
+orb.yml
+node_modules/

CHANGELOG.md

@@ -1,13 +1,39 @@
-# Orb Project Template
+# commitlint orb
 
 [![CircleCI Build Status](https://circleci.com/gh/conventional-changelog/commitlint-orb.svg?style=shield "CircleCI Build Status")](https://circleci.com/gh/conventional-changelog/commitlint-orb) [![CircleCI Orb Version](https://badges.circleci.com/orbs/conventional-changelog/commitlint.svg)](https://circleci.com/orbs/registry/orb/conventional-changelog/commitlint) [![GitHub License](https://img.shields.io/badge/license-MIT-lightgrey.svg)](https://raw.githubusercontent.com/conventional-changelog/commitlint-orb/master/LICENSE) [![CircleCI Community](https://img.shields.io/badge/community-CircleCI%20Discuss-343434.svg)](https://discuss.circleci.com/c/ecosystem/orbs)
 
 
 
-A starter template for orb projects. Build, test, and publish orbs automatically on CircleCI with [Orb-Tools](https://circleci.com/orbs/registry/orb/circleci/orb-tools).
+Lint your commit messages in a CircleCI job.
 
-Additional READMEs are available in each directory.
+Add this orb's `commitlint/lint` job to your existing CircleCI workflow to utilize [commitlint](https://github.com/conventional-changelog/commitlint) for validating commit messages against the [conventional commit format](https://conventionalcommits.org/).
 
+## Example
+
+This example shows importing the `commitlint` orb into a basic CircleCI 2.1 config file, and adding the `commitlint/lint` job to a workflow. This configuration will lint every commit pushed to the repository.
+
+```yaml
+version: 2.1
+  orbs:
+    # Use the latest version of the orb.
+    # See the Orb Registry, or GitHub Releases
+    commitlint: conventional-changelog/commitlint@<latest version>
+  workflows:
+    my-workflow:
+      jobs:
+        - commitlint/lint
+```
+
+CircleCI will report back the status of the `commitlint/lint` job and block a Pull Request from being merged if the job fails.
+
+## Run the commitlint orb locally
+Want to test out the commitlint orb in your CI pipeline before pushing your changes? Use the CircleCI CLI to run any job defined in your `.circleci/config.yml` locally, including jobs from orbs.
+
+Assuming your config file looks similar to the example above, and you have the [CircleCI CLI](https://circleci.com/docs/2.0/local-cli/) installed, you can run this orb for the current project locally with the following command.
+
+```shell
+circleci local execute --job commitlint/lint
+```
 
 
 ## Resources

README.md

@@ -0,0 +1 @@
+module.exports = {extends: ['@commitlint/config-conventional']}

commitlint.config.js

@@ -1,15 +1,10 @@
 version: 2.1
 
 description: >
-  Sample orb description
-# What will your orb allow users to accomplish?
-# Descriptions should be short, simple, and informative.
+  commitlint helps your team adhere to a standard commit convention.
+  Add commit message linting to your CI process to prevent non-standard commit messages from being merged, and provide contrinbutors with details for resolving their PR.
 
-# This information will be displayed in the orb registry and is not mandatory.
 display:
-  home_url: "https://www.website.com/docs"
-  source_url: "https://www.github.com/EXAMPLE_ORG/EXAMPLE_PROJECT"
+  home_url: "https://commitlint.js.org/"
+  source_url: "https://github.com/conventional-changelog/commitlint"
 
-# If your orb requires other orbs, you can import them like this. Otherwise remove the "orbs" stanza.
-# orbs:
-#  hello: circleci/[email protected]