-
Notifications
You must be signed in to change notification settings - Fork 22
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
base: main
Are you sure you want to change the base?
Conversation
|
||
assert readme_url.scheme == "https" | ||
assert readme_url.netloc in ( | ||
"api.opensuse.org", |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
c4f90b3
to
de1a75f
Compare
There was a problem hiding this 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:
- markdown consistency should be enforced in the BCI-dockerfile-generator and not here
- 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) - artifacthub will barf at us, if either the readme-url is wrong or the readme is not markdown
- 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
No description provided.