Document CIRRUS_CLONE_SUBMODULES

[edigaryev]

See cirruslabs/cirrus-ci-agent#114.

[emaste]

I tried to use this on my submodules project: emaste/freebsd@8c152bf

But it looks like the submodules were not populated: https://cirrus-ci.com/task/6005207805984768

I'll try to look into what happened. Maybe interaction with CIRRUS_CLONE_DEPTH?

[edigaryev]

I tried to use this on my submodules project: emaste/freebsd@8c152bf

But it looks like the submodules were not populated: https://cirrus-ci.com/task/6005207805984768

I'll try to look into what happened. Maybe interaction with CIRRUS_CLONE_DEPTH?

You did everything right! This just hasn't been rolled out yet.

It probably will be after this PR gets merged 🙌

[fkorotkov]

It should be available now.

[emaste]

Looks like it is not working for me - compare https://cirrus-ci.com/build/5139496078409728 and https://cirrus-ci.com/task/4625231508668416

The first sets CIRRUS_CLONE_SUBMODULES: true and the second runs git submodule init and git submodule update. The first reports

Updating submodules...
Failed to update submodules: object not found!

[edigaryev]

Looks like it is not working for me - compare https://cirrus-ci.com/build/5139496078409728 and https://cirrus-ci.com/task/4625231508668416

The first sets CIRRUS_CLONE_SUBMODULES: true and the second runs git submodule init and git submodule update. The first reports

Updating submodules...
Failed to update submodules: object not found!

It seems that the emaste/drm-kmod@b57b441 commit referenced from the drm-kmod submodule is orphaned and that causes the object not found error.

What's interesting though is how git submodule update manages to fetch it anyway, while go-git fails.

I'll take a look at this, but for a quick workaround you can assign this commit to some branch or tag as recommended in GitHub documentation.

[edigaryev]

Turns out that the official Git implementation does a second fetch attempt, while go-git doesn't, more details in go-git/go-git#284.

Let's see how long it takes for the upstream to merge the fix, while you can still use the workaround above.