feat: initial orb release [semver:major]

Author: KyleTryon

Diff for: .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/orb-tools@10.0
-  bats: circleci/bats@1.0
   shellcheck: circleci/shellcheck@2.0
+  bats: circleci/bats@1.0
+  node: circleci/node@4.7.0
 
 # 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 "communitypartner@circleci.com"
+                  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

Diff for: .gitignore

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

Diff for: 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

Diff for: README.md

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

Diff for: 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/hello-build@0.0.5

Diff for: src/@orb.yml

@@ -0,0 +1,11 @@
+description: |
+  Add the `commitlint/lint` job to your existing workflow to quickly and easily begin linting your commit mesages.
+  Ensure you have first added your `commitlint.config.js` file to your project.
+usage:
+  version: 2.1
+  orbs:
+    commitlint: conventional-changelog/commitlint@1.0
+  workflows:
+    my-workflow:
+      jobs:
+        - commitlint/lint

Diff for: src/README.md

@@ -0,0 +1,39 @@
+description: |
+  Add this lint job to your workflow to easily enable commit message lint checking as a step in your CI process.
+
+
+docker:
+  - image: "cimg/node:<<parameters.node-version>>"
+
+parameters:
+  config-path:
+    type: string
+    description: Path to commitlint config file
+    default: "./commitlint.config.js"
+  configs:
+    type: string
+    description: A space-separated list of commitlint config packages to install.
+    default: "@commitlint/config-conventional"
+  target-branch:
+    type: string
+    description: Commits in the current branch will be compared against the target branch for linting. All commits not present in the target branch will be linted.
+    default: "main"
+  node-version:
+    type: string
+    default: "16.5.0"
+    description: "Specify the NodeJS version used to run the commitlint job. This should not usually need to be changed."
+  max-count:
+    type: integer
+    default: 10
+    description: "The maximum number of commits to lint."
+steps:
+  - checkout
+  - run:
+      name: "Run commitlint"
+      environment:
+        CL_PARAM_CONFIG_PATH: "<<parameters.config-path>>"
+        CL_PARAM_NODE_VERSION: "<<parameters.node-version>>"
+        CL_PARAM_TARGET_BRANCH: "<<parameters.target-branch>>"
+        CL_PARAM_CONFIGS: "<<parameters.configs>>"
+        CL_PARAM_MAX_COUNT: "<<parameters.max-count>>"
+      command: <<include(scripts/lint.sh)>>

Diff for: src/commands/README.md

@@ -0,0 +1,28 @@
+#!/bin/bash
+if ! command -v commitlint &> /dev/null
+then
+  if [[ $EUID == 0 ]]; then export SUDO=""; else export SUDO="sudo"; fi
+  $SUDO npm install -g @commitlint/cli "$CL_PARAM_CONFIGS"
+fi
+
+current_branch="$(git rev-parse --abbrev-ref HEAD)"
+target_branch="$CL_PARAM_TARGET_BRANCH"
+git_log="$(git log --reverse --max-count="$CL_PARAM_MAX_COUNT" --format="format:%H")"
+
+if [ -z "$git_log" ]; then
+  echo "[WARNING] There are no commits in the log to lint."
+  exit 0
+fi
+
+# If there is only one commit, set target_head to that commit
+if [ "$(echo "$git_log" | wc -l | xargs)" == "1" ]; then
+  target_head=""
+elif [ "$current_branch" != "$target_branch" ]; then
+  # Using the ^ at the end git logs lower bound is not inclusive
+  target_head="$(git cherry "$target_branch" | head -1 | cut -d " " -f2-)^"
+else
+  commit="$(echo "$git_log" | head -1)"
+  target_head="$(git log "$commit^" -1 --pretty=%H)"
+fi
+
+commitlint --verbose --config "$CL_PARAM_CONFIG_PATH" --from="$target_head"

Diff for: src/commands/greet.yml

@@ -0,0 +1,72 @@
+setup() {
+  cd "$BATS_SUITE_TMPDIR" || exit
+  yarn add @commitlint/config-conventional -s
+
+  export git_dir="${BATS_TEST_TMPDIR}/git_dir"
+  mkdir -p "$git_dir" && cd "$git_dir" || exit
+
+  git init
+  echo "module.exports = {extends: ['@commitlint/config-conventional']}" > "commitlint.config.js"
+  export CL_PARAM_CONFIG_PATH="commitlint.config.js"
+  export CL_PARAM_MAX_COUNT="10"
+}
+
+main() {
+  bash "$BATS_TEST_DIRNAME/../../src/scripts/lint.sh"
+}
+
+test_commit() {
+  local message="$1"
+
+  echo -e "${message}\n" >> file.txt
+  git add file.txt && git commit -m "$message"
+}
+
+@test 'Test linting the fist bad commit' {
+  test_commit "bad: commit"
+  echo "Commit Created"
+  export current_branch="$(git rev-parse --abbrev-ref HEAD)"
+  echo "Current branch: $current_branch"
+  export CIRCLE_BRANCH="$current_branch"
+  export CL_PARAM_TARGET_BRANCH="$current_branch"
+  run main
+  [[ "$output" == *"found 1 problems, 0 warnings"* ]]
+  [[ "$output" == *"[type-enum]"* ]]
+}
+
+@test 'Test linting the fist good commit' {
+  test_commit "chore: setup"
+
+  current_branch="$(git rev-parse --abbrev-ref HEAD)"
+  export CIRCLE_BRANCH="$current_branch"
+  export CL_PARAM_TARGET_BRANCH="$current_branch"
+
+  run main
+  [[ "$output" == *"found 0 problems, 0 warnings"* ]]
+}
+
+@test 'Test linting with no commits' {
+  export CIRCLE_BRANCH="main"
+  export CL_PARAM_TARGET_BRANCH="main"
+
+  run main
+  [[ "$output" == *"[WARNING] There are no commits in the log to lint."* ]]
+}
+
+@test 'Test linting the history on the same branch' {
+  test_commit "bad: commit"
+
+  for i in {1..5}; do
+    test_commit "chore: add $i"
+  done
+
+  export current_branch="$(git rev-parse --abbrev-ref HEAD)"
+  export CIRCLE_BRANCH="$current_branch"
+  export CL_PARAM_TARGET_BRANCH="$current_branch"
+
+  run main
+  echo "$output"
+  [[ "$output" == *"found 1 problems, 0 warnings"* ]]
+  [[ "$output" == *"[type-enum]"* ]]
+}
+

Diff for: src/examples/README.md

@@ -0,0 +1,113 @@
+setup() {
+  cd "$BATS_SUITE_TMPDIR" || exit
+  yarn add @commitlint/config-conventional
+
+  export git_dir="${BATS_TEST_TMPDIR}/git_dir"
+  mkdir -p "$git_dir" && cd "$git_dir" || exit
+
+  git init
+
+  for i in {1..5}; do
+    test_commit "chore: add $i"
+  done
+
+  target_branch="$(git rev-parse --abbrev-ref HEAD)"
+  git checkout -b "$BATS_TEST_NAME"
+  current_branch="$(git rev-parse --abbrev-ref HEAD)"
+
+  export CIRCLE_BRANCH="$current_branch"
+  export CL_PARAM_TARGET_BRANCH="$target_branch"
+  export CL_PARAM_CONFIG_PATH="commitlint.config.js"
+  export CL_PARAM_MAX_COUNT="10"
+
+  echo "module.exports = {extends: ['@commitlint/config-conventional']}" > "commitlint.config.js"
+}
+
+main() {
+  bash "$BATS_TEST_DIRNAME/../../src/scripts/lint.sh"
+}
+
+test_commit() {
+  local message="$1"
+
+  echo -e "${message}\n" >> file.txt
+  git add file.txt && git commit -m "$message"
+}
+
+@test 'Test linting on one bad commit' {
+  test_commit "bad: commit"
+
+  run main
+  [[ "$output" == *"found 1 problems, 0 warnings"* ]]
+  [[ "$output" == *"[type-enum]"* ]]
+}
+
+@test 'Test linting on one good commit' {
+  test_commit "chore: commit"
+
+  run main
+  [[ "$output" == *"found 0 problems, 0 warnings"* ]]
+}
+
+@test 'Test linting the body of a commit' {
+  test_commit "chore: this is a commit with a long body
+
+Long line in the body should fail Lorem Ipsum is simply dummy text of the printing and typesetting industry Long line in the body should fail Lorem Ipsum is simply dummy text of the printing and typesetting industry.
+"
+  run main
+  [[ "$output" == *"found 1 problems, 0 warnings"* ]]
+  [[ "$output" == *"[body-max-line-length]"* ]]
+}
+
+@test 'Test linting multiple commits with only one bad one' {
+  test_commit "bad: commit"
+
+  for i in {1..5}; do
+    test_commit "chore: this is a commit"
+  done
+
+  run main
+  [[ "$output" == *"found 1 problems, 0 warnings"* ]]
+  [[ "$output" == *"[type-enum]"* ]]
+}
+
+@test 'Test linting multiple commits that are all good' {
+  for i in {1..10}; do
+    test_commit "chore: this is a commit"
+  done
+
+  run main
+  [[ "$output" == *"found 0 problems, 0 warnings"* ]]
+}
+
+@test 'Test rely bad' {
+  for i in {1..5}; do
+    test_commit "chore: this is a commit"
+  done
+
+  for i in {1..5}; do
+    test_commit "this is a commit commit $1"
+  done
+
+  for i in {1..10}; do
+    test_commit "chore: this is a commit"
+  done
+
+  run main
+  error_count="$(echo "${output#0}" | grep -c "found 2 problems, 0 warnings")"
+  [[ $error_count -eq 5 ]]
+}
+
+@test 'Test linting on the same branch' {
+  test_commit "bad: commit"
+
+  for i in {1..5}; do
+    test_commit "chore: this is a commit"
+  done
+
+  export CL_PARAM_TARGET_BRANCH="$CIRCLE_BRANCH"
+
+  run main
+  [[ "$output" == *"found 1 problems, 0 warnings"* ]]
+  [[ "$output" == *"[type-enum]"* ]]
+}