Support github release with just source code artifacts

[thompson-tomo]

Describe the problem/challenge you have
I want to be unpack the source code of the github release which i am syncing even when the only artifacts are source code.

Describe the solution you'd like
The checking of additional files on the release is removed and the source code *.tar.gz is always downloaded.

Anything else you would like to add:
I am aware that i could sync git repo's directly however the use case i am interested in as following.

Semantic conventions perform a github release, projects which consume the conventions would get a renovate pr to update the version. As part of this renovate pr ci tasks run to generate the new artifacts based on the latest semantic conventions.

My config is:

apiVersion: vendir.k14s.io/v1alpha1
kind: Config

directories:
- # path is relative to `vendir` CLI working directory
  path: semantic_conventions/tmp
  contents:
  - path: semconvrepo2
    githubRelease:
      # slug for repository (org/repo) (required)
      slug: open-telemetry/semantic-conventions
      # use release tag (optional)
      # optional if tagSelection is specified (available in v0.22.0+)
      tag: v1.38.0
      disableAutoChecksumValidation: true

Currently when i run the vendir sync command I get the following:

Fetching: semantic_conventions/tmp + semconvrepo2 (github release open-telemetry/semantic-conventions@v1.38.0)

vendir: Error: Syncing directory 'semantic_conventions/tmp':
  Filtering paths in directory 'semconvrepo':
    Expected to find at least one file within directory

The support of unpacking of *tar.gz is handled via #431

---

Vote on this request

This is an invitation to the community to vote on issues, to help us prioritize our backlog. Use the "smiley face" up to the right of this comment to vote.

👍 "I would like to see this addressed as soon as possible"
👎 "There are other more important things to focus on right now"

We are also happy to receive and review Pull Requests if you want to help working on this issue.

[github-actions]

This issue is being marked as stale due to a long period of inactivity and will be closed in 5 days if there is no response.

[thompson-tomo]

Awaiting feedback.

[joaopapereira]

Sorry for the late reply.
I was looking into your proposal and I think that maybe we need to do some change in the configuration to be more explicit with what we want to achieve, specially because it does not come as an asset.

apiVersion: vendir.k14s.io/v1alpha1
kind: Config

directories:
- # path is relative to `vendir` CLI working directory
  path: semantic_conventions/tmp
  contents:
  - path: semconvrepo2
    githubRelease:
      slug: open-telemetry/semantic-conventions
      tag: v1.38.0
      sourceCodeOnlyDownload: true # default would be false to do not break current behavior

This flag would do:

1. check if there are assets and if other assets are present it fails // we can discuss this part but I think we should be explicit because this is an extreme case and should not be something that should be widely used
2. given there are no access and the flag is true it downloads the tarball and possibly unpacks it

What do you think?
@Zebradil any suggestions?

[thompson-tomo]

Happy with an explicit opt-in flag but I wouldn't have it fail if true & assets added. This is to support the scenario where the desired files is not an explicit asset hence opting to use the source code archive.

[joaopapereira]

I just updated my comment because I did not understood what I wrote lol...
As I said I think we can discuss that point. In one hand I feel like the behavior should cover one edge case and I thought that this was your use case (no assets but want code). But I don't think that would be a major problem if we do not fail.

[github-actions]

This issue is being marked as stale due to a long period of inactivity and will be closed in 5 days if there is no response.