git-shallow-clone-orb

Usage

See the orb registry listing for usage guidelines.

Contributing

We welcome issues to and pull requests against this repository!

Publish

To publish orb, add commit message [semver:patch|minor|major|skip] on master branch's commit.

• [semver:patch]
• [semver:minor]
• [semver:major]
• [semver:skip]

Add Test

Add test job in .circleci/config.yml.

jobs:
  # Define one or more jobs which will utilize your orb's commands and parameters to validate your changes.
  integration-test-checkout:
    docker:
      - image: cimg/base:stable
    steps:
      - git-shallow-clone/checkout

Call it from integration-test_deploy job, and add as orb-tools/dev-promote-prod-from-commit-subject required job.

  integration-test_deploy:
    when: << pipeline.parameters.run-integration-tests >>
    jobs:
      - integration-test-checkout # <-- this line!

      - orb-tools/dev-promote-prod-from-commit-subject:
          orb-name: guitarrapc/git-shallow-clone
          add-pr-comment: false
          fail-if-semver-not-indicated: true
          publish-version-tag: false
          requires:
            - integration-test-checkout # <-- this line!
          filters:
            branches:
              only:
                - master
                - main

Basic orb setup

setup orb account and namespace.

# require perconal api tokens
$ circleci setup
$ circleci namespace create guitarrapc github guitarrapc
$ circleci orb create guitarrapc/git-shallow-clone

validate before publish.

$ cd ./src
$ circleci orb validate orb.yml

publish orb to the alpha.

$ cd ./src
$ circleci orb publish orb.yml guitarrapc/git-shallow-clone@dev:alpha

publish orb to the dev.

$ cd ./src
$ circleci orb publish orb.yml guitarrapc/git-shallow-clone@dev:0.x.0

publish orb to the production.

$ cd ./src
$ circleci orb publish promote guitarrapc/[email protected]