What is the recommended GitHub Action checkout to get all metadata needed for version?

[ketozhang]

I understand by default, https://github.com/actions/checkout, does a shallow copy which is not enough for hatch-vcs to fetch the latest version.

I've not tested

• Tags only fails

  steps:
      - uses: actions/checkout@v3
        with:
          fetch-tags: true

• Full history is the extreme end, but can we have less?

  steps:
      - uses: actions/checkout@v3
        with:
          fetch-depth: 0

[ofek]

This is I think more of a question for the underlying implementation (https://github.com/pypa/setuptools_scm) but cc @RonnyPfannschmidt in any case

[RonnyPfannschmidt]

Currently there's no easy way to avoid this

I'm thinking of having it actively ask GitHub instead

[ofek]

I'm not sure how easy it would be to adapt but this is what I did at work to fetch only what was necessary in a different circumstance: https://github.com/DataDog/integrations-core/blob/13b7646c076108d76194c67e80c57515564fd489/.github/workflows/compute-matrix.yml#L38-L62