Skip to content

do linkchecks for changelog lint #1722

Closed

Description

@RonnyPfannschmidt

#1721 showed that we don't check those and mistakes happen, #1720 related

Activity

  1. nicoddemus commented on Jul 13, 2016

    @nicoddemus
    Member

    Does anyone have a suggestion on how to do this? I took a look at rst-lint we use and it does not have that option.

  2. The-Compiler commented on Jul 13, 2016

    @The-Compiler
    Member

    LinkChecker maybe? Hopefully it also runs locally over the generated HTML files.

    If we do this with Travis we probably shouldn't do it on every push though.

  3. nicoddemus commented on Jul 13, 2016

    @nicoddemus
    Member

    Hmm sounds good. Why do you say we shouldn't do it on every push? So people's PRs are not blocked if some unrelated link is broken?

    Python 3 is not yet supported.

    Sad panda is sad.

  4. The-Compiler commented on Jul 13, 2016

    @The-Compiler
    Member

    No, because it's not very nice to do dozens (hundreds?) of HTTP request with every push 😉 I guess we could use Travis' cron feature?

  5. RonnyPfannschmidt commented on Jul 13, 2016

    @RonnyPfannschmidt
    MemberAuthor

    should we make it part of the pre-release process?

  6. nicoddemus commented on Jul 13, 2016

    @nicoddemus
    Member

    No, because it's not very nice to do dozens (hundreds?) of HTTP request with every push 😉

    Heh, right. 😝

    should we make it part of the pre-release process?

    Good idea. A simple environment on tox that should be part of the release process sounds good, executed locally.

  7. added
    type: docsdocumentation improvement, missing or needing clarification
    on Jul 13, 2016
  8. adamtheturtle commented on Aug 26, 2016

    @adamtheturtle

    In case it saves you a few minutes, https://github.com/jenca-cloud/jenca-authentication/blob/master/.travis.yml#L16 is a .travis.yml which only installs and runs linkchecker on Python 3 builds.

  9. nicoddemus commented on Aug 26, 2016

    @nicoddemus
    Member
  10. The-Compiler commented on Sep 20, 2016

    @The-Compiler
    Member

    Seems like Sphinx also has a linkcheck builder built-in.

  11. added
    type: infrastructureimprovement to development/releases/CI structure
    and removed
    type: docsdocumentation improvement, missing or needing clarification
    on Sep 28, 2017
  12. Zac-HD commented on Dec 5, 2018

    @Zac-HD
    Member

    An easy contribution would be to run the Sphinx linkcheck builder from release.py, after the fix_formatting() step.

  13. mandarvaze commented on Jun 3, 2019

    @mandarvaze

    Anyone working on this ? I would like to work on this.

    I'm a first time contributor, and may require a bit of help, especially how to test the change etc. (Relevant code snippet and possible solution already provided by @Zac-HD - Thanks.)

  14. 4 remaining items

  15. mandarvaze commented on Jun 3, 2019

    @mandarvaze

    Ideally we'd have a new tox env that just does the linkcheck, which can be run before making a release.

    Understood. I can do what @blueyed suggested.

    And add this to the release checklist!

    Do you mean update HOWTORELEASE.rst ?
    or
    call it from release.py as you suggested above ?

  16. nicoddemus commented on Jun 6, 2019

    @nicoddemus
    Member

    @mandarvaze just call it from release.py should be fine. 👍

  17. steffenschroeder commented on Jul 13, 2019

    @steffenschroeder
    Contributor

    started to working on this during EuroPython2019 sprint. (with the help of @The-Compiler)
    Will open 2 PRs:

    1. for the broken links (sphinx-build's linkcheck only reports one error at a time so it takes some time)
    2. for adding tox and and release.py
  18. steffenschroeder commented on Jul 13, 2019

    @steffenschroeder
    Contributor

    Is https://docs.pytest.org/en/latest/adopt.html (April 2015 is "adopt pytest month") still needed? It is still in the repo and contains a broken link (to google forms). Can this be deleted? If not, what can I with the link?

  19. The-Compiler commented on Jul 15, 2019

    @The-Compiler
    Member

    @steffenschroeder I'd keep it around - it's nice to know it was a thing that happened, and we should probably do that again some day! Which of the links is broken? The two form links I see there seem to work fine. I'd probably just remove the link and maybe strike through the text or so.

  20. steffenschroeder commented on Jul 15, 2019

    @steffenschroeder
    Contributor

    @The-Compiler the Partner projects, sign up here! is broken an can probably be removed (or strike through).
    The assert, markers and distributed links could be changed to proper locations. Will do so.

  21. The-Compiler commented on Jul 16, 2019

    @The-Compiler
    Member

    @steffenschroeder Odd, that link seems to be okay - it leads to a The form "Request a helper for your open source project, for "adopt pytest month"" is no longer accepting responses.-page, but that's not a 404 or anything, so I wonder why linkcheck complains about it. Either way, seems fine to remove the text.

  22. steffenschroeder commented on Jul 16, 2019

    @steffenschroeder
    Contributor

    @The-Compiler although the link works in the browser, checklinks will report it as an error. So I have 2 options:

    1. remove the link
    2. add it to a whitelist as false positive

    For this particular case, I removed it.

  23. steffenschroeder commented on Jul 17, 2019

    @steffenschroeder
    Contributor

    #5614 will add link checking for all links in the documentation.
    The check will only be done locally during the release process (release.py)

    #5613 will correct all broken links the linkchecker found.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    good first issueeasy issue that is friendly to new contributortype: infrastructureimprovement to development/releases/CI structure

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions