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

Fix metadata-up-to-date lint script #12222

Merged
merged 2 commits into from
Sep 7, 2023

Conversation

simondeziel
Copy link
Member

The script would abort when a delta between "before" and "after" was noticed because diff would return with a non-0 code. Fix that so that we can see the delta if there is one and use "unified" mode.

Signed-off-by: Simon Deziel <simon.deziel@canonical.com>
…eturns non-0

Signed-off-by: Simon Deziel <simon.deziel@canonical.com>
@simondeziel
Copy link
Member Author

simondeziel commented Sep 6, 2023

@ru-fu it seems this link is sometimes returning a 403:

2023-09-06T18:03:22.4520974Z ( doc-cheat-sheet: line  368) broken    https://docutils.sourceforge.io/docs/ref/rst/directives.html#list-table - 403 Client Error: Forbidden for url: https://docutils.sourceforge.io/docs/ref/rst/directives.html

Which is easy enough to trigger:

$ for i in $(seq 10); do wget -qSO /dev/null https://docutils.sourceforge.io/docs/ref/rst/directives.html#list-table 2>&1 | head -n1; done
  HTTP/1.1 200 OK
  HTTP/1.1 200 OK
  HTTP/1.1 200 OK
  HTTP/1.1 403 Forbidden
  HTTP/1.1 200 OK
  HTTP/1.1 200 OK
  HTTP/1.1 200 OK
  HTTP/1.1 200 OK
  HTTP/1.1 200 OK
  HTTP/1.1 200 OK

Is there an exclusion mechanism we can use to ignore it?

@github-actions github-actions bot added the Documentation Documentation needs updating label Sep 6, 2023
doc/conf.py Outdated Show resolved Hide resolved
@ru-fu
Copy link
Contributor

ru-fu commented Sep 7, 2023

it seems this link is sometimes returning a 403:

I've never seen that before - maybe it was just flaky yesterday when you tested?
Or have you seen it before?

@simondeziel
Copy link
Member Author

I can't get the 403 today so it probably was a one off. As such, I dropped all the link checker changes from the PR. Thanks @ru-fu!

@github-actions github-actions bot removed the Documentation Documentation needs updating label Sep 7, 2023
@simondeziel
Copy link
Member Author

Hmm, this time it's not a 403 but a TLS handshake failure:

( doc-cheat-sheet: line  368) broken    https://docutils.sourceforge.io/docs/ref/rst/directives.html#list-table - HTTPSConnectionPool(host='docutils.sourceforge.io', port=443): Max retries exceeded with url: /docs/ref/rst/directives.html (Caused by SSLError(SSLError(1, '[SSL: SSLV3_ALERT_HANDSHAKE_FAILURE] sslv3 alert handshake failure (_ssl.c:1007)')))

And it's not just us apparently: https://www.ssllabs.com/ssltest/analyze.html?d=docutils.sourceforge.io#12098

If the doc is available from another source, maybe we should switch.

@tomponline tomponline merged commit db6cec5 into canonical:main Sep 7, 2023
48 of 50 checks passed
@simondeziel simondeziel deleted the lint-metadata branch September 7, 2023 15:45
@ru-fu
Copy link
Contributor

ru-fu commented Sep 7, 2023

If the doc is available from another source, maybe we should switch.

Hmm, this is the main source for it, I would be surprised if it was available somewhere else.
Let's keep an eye on it.

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.

3 participants