https://github.com/guitarrapc/git-shallow-clone-orb

circleci orb to execute git shallow clone for faster checkout.
https://github.com/guitarrapc/git-shallow-clone-orb

circleci circleci-orbs clone-repos git

Last synced: 2 months ago
JSON representation

circleci orb to execute git shallow clone for faster checkout.

• Host: GitHub
• URL: https://github.com/guitarrapc/git-shallow-clone-orb
• Owner: guitarrapc
• License: mit
• Created: 2019-08-23T18:31:24.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2023-10-08T16:21:43.000Z (over 1 year ago)
• Last Synced: 2024-06-24T00:18:18.098Z (7 months ago)
• Topics: circleci, circleci-orbs, clone-repos, git
• Homepage: https://circleci.com/orbs/registry/orb/guitarrapc/git-shallow-clone
• Size: 153 KB
• Stars: 21
• Watchers: 3
• Forks: 12
• Open Issues: 6
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
[![CircleCI](https://dl.circleci.com/status-badge/img/gh/guitarrapc/git-shallow-clone-orb/tree/main.svg?style=svg)](https://dl.circleci.com/status-badge/redirect/gh/guitarrapc/git-shallow-clone-orb/tree/main)

![Orb Version Badge](https://badges.circleci.com/orbs/guitarrapc/git-shallow-clone.svg)

## Git-shallow-clone-orb

## Usage

See the [orb registry listing](http://circleci.com/orbs/registry/orb/guitarrapc/git-shallow-clone) for usage guidelines.

## Contributing

We welcome [issues](https://github.com/guitarrapc/git-shallow-clone-orb/issues) to and [pull requests](https://github.com/guitarrapc/git-shallow-clone-orb/pulls) against this repository!

## Publish

To publish orb, push new tag to remote.

## Add Test

Add test job in .circleci/config.yml.

```yaml

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.

```yaml

  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.

```shell

# 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]

```