Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Test README.md urls in the container annotations (Fixes #427) #430

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dirkmueller
Copy link
Member

No description provided.

@dirkmueller dirkmueller marked this pull request as draft March 27, 2024 12:38

assert readme_url.scheme == "https"
assert readme_url.netloc in (
"api.opensuse.org",
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This one shouldn't be allowed, it's only reachable with credentials, which makes it useless for the use case of artifacthub

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

api.opensuse.org has a /public route that does not require credentials and can be used for the use case of artifacthub

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But we do not use it, we set the readme-url to github for tumbleweed and for all other we rely on %SOURCEURL%, which doesn't use the /public/ route.

@dirkmueller dirkmueller force-pushed the readme_tests branch 2 times, most recently from c4f90b3 to de1a75f Compare April 4, 2024 17:40
Copy link
Collaborator

@dcermak dcermak left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not think that this is worth testing:

  1. markdown consistency should be enforced in the BCI-dockerfile-generator and not here
  2. the readme-url for non-tumbleweed is useless in the staging as it points to OBS/IBS and is actually incorrect (you get stuff like https://build.opensuse.org/package/show/devel:BCI:SLE-15-SP6/nodejs-20-image?rev=95dac3af7bb409598dde88b559cfa788/README.md which OBS cannot correctly resolve)
  3. artifacthub will barf at us, if either the readme-url is wrong or the readme is not markdown
  4. we didn't have a single regression/issue here

If we start seeing issues with the Readmes, then we can reconsider, but atm, this is just another test that will provide very limited value (as we cannot run it against staging) and be potentially yet another thing that can flake

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants