flatpak-external-data-checker icon indicating copy to clipboard operation
flatpak-external-data-checker copied to clipboard

Parameter in flathub.json to prevent f-e-d-c from submitting a merge request

Open TheEvilSkeleton opened this issue 4 years ago • 6 comments

TheEvilSkeleton avatar Apr 07 '21 20:04 TheEvilSkeleton

I guess we can add a boolean option like external-data-checker-disable, which would cause f-e-d-c to skip the app. There is no point in checking the app if we're not submitting PRs with updates. CC @barthalion

gasinvein avatar Apr 07 '21 20:04 gasinvein

Can you clarify why you would want this? Is it so you can add the annotations and run the tool manually, but not get PRs from Flathub's instance of the bot?

If so, this would need to be written in such a way that running the tool manually doesn't just read the file, think "oh nothing to do here" and exit :)

wjt avatar Apr 07 '21 21:04 wjt

Can you clarify why you would want this? Is it so you can add the annotations and run the tool manually, but not get PRs from Flathub's instance of the bot?

Exactly this. I maintain the ungoogled-chromium flatpak, so I would like to have an easy way to gather the URL, hash, etc. without f-e-d-c submitting a merge request.

If so, this would need to be written in such a way that running the tool manually doesn't just read the file, think "oh nothing to do here" and exit :)

Can you give me an example? I want to implement this in the manifest as soon as possible.

TheEvilSkeleton avatar Apr 07 '21 21:04 TheEvilSkeleton

Something should check for a no-global-check key in flathub.json and if its value is true, skip the global check. However, IMO, just running this program, with no arguments, against such a repo should not respect that flag.

https://github.com/flathub/actions/blob/master/flathub-external-data-checker/entrypoint.sh is what actually runs this program on every repo in the flathub org.

My suggestion:

  • Either handle this new flathub.json flag entirely in that entrypoint; or
  • Add an opt-in behaviour --respect-no-global-check (?) which, if passed to this program, makes it check for such a flag in flathub.json and short-circuit if found. Then modify the action to pass that flag.

The behaviour I want to preserve is that if you clone the repo, then run this program with no arguments, it should behave correctly. You shouldn't have to temporarily edit flathub.json or manually pass --no-really-check-it.

wjt avatar Apr 26 '21 21:04 wjt

@wjt I was thinking about some environment variable to detect the common check, but your suggestion seems more valid. Maybe generalize it a bit and make reading flathub.json opt-in altogether (enabled for global check, disabled by default otherwise)?

gasinvein avatar Apr 26 '21 21:04 gasinvein

Exactly this. I maintain the ungoogled-chromium flatpak, so I would like to have an easy way to gather the URL, hash, etc. without f-e-d-c submitting a merge request.

@TheEvilSkeleton I'm also being affected by this, so in my Github workflow I'm using some jq magic to add the x-checker-data property before running f-e-d-c, and remove it after.
You can adapt this for your app as a temporary workaround.

tinywrkb avatar Aug 06 '21 20:08 tinywrkb