shallow checkout

[circleci-public]

shallow checkout

[felicianotech]

In what context? For what?

[joshribakoff-sm]

The link I posted outlines how you would do a shallow checkout, and why:

Shallow cloning a git repository can offer some performance improvement, especially for larger projects with a number of commits, by pulling the smallest number of changes possible. This can either be implemented manually using a custom cloning step or by utilizing an Orb.

https://github.com/CircleCI-Public/cimg-node#getting-started
Your readme instructs users to run - checkout, which does a deep checkout I think?

In my case, I need the main branch and whatever branch CI is running on, but I don't need the full history of the main branch, or unrelated branches.

[felicianotech]

If you're talking about the example config in this repository's readme, it is showing the CircleCI checkout step. The step doesn't always do a full clone, it depends on the scenario. Regardless, it's the default way to checkout code on CircleCI which works for most people, this is why it's used in the example.

Thank you for the suggestion.

[joshribakoff-sm]

I assumed this orb was providing that step, but if not apologies for filing on the wrong repo

[felicianotech]

This repository is for the Node.js Convenience Image. If you're looking for the Node.js Orb, that can be found here: https://github.com/CircleCI-Public/node-orb

I hope that helps. 🙂