-
Notifications
You must be signed in to change notification settings - Fork 235
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
Move the changelog to read the docs #423
Move the changelog to read the docs #423
Conversation
@@ -49,7 +49,7 @@ repos: | |||
- id: rst | |||
name: rst | |||
entry: rst-lint --encoding utf-8 | |||
files: ^(CHANGES.rst|development.rst|README.rst)$ | |||
files: ^(README.rst)$ |
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.
Don't we want to lint the removed rst-files?
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.
Don't we want to lint the removed rst-files?
We do, and RTD does lint for us. This lint is for files under the project root though and so should be removed since we're asking for it to lint file that no longer exist
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.
Got it, thanks! 👍
Can we still lint on commit somehow? So that you don't have to wait for RTD to do it.
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'd need to double check @BeyondEvil ( I think so ) but regardless of whether we do or not this line achieves nothing and should be removed since the files no longer exist.
I made a note to double check linting
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.
We also have a tox command to build documentation and it runs in GHA on all PRs, so we definitely don't need to wait on upload to RTD for feedback @BeyondEvil
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.
Right, sphinx, so can I assume sphinx will catch linting issues then? @gnikonorov
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.
Right, sphinx, so can I assume sphinx will catch linting issues then? @gnikonorov
I think so. I made a note to double check this.
We also can't use this linter since the RST syntax is different ( I remember trying to use it and having it fail in the original doc migration )
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.
Opened an issue to investigate linting RTD @BeyondEvil (#428). Can you please review this change? I'd like to get it merged if there are no objections on your end. I'll tackle any linting requirements ( if needed ) in a follow up PR
How about moving the changelog outside SCM to https://github.com/pytest-dev/pytest-html/releases This would make much easier to maintain and we would only have to manually copy/paste old entries and add them to exiting tags. After that, we only remove the changelog file and update the dos to point to github release page. After that, we no longer need to remind to update the changelog on changes, the bot does it for us. |
Doesn't that still need more work @ssbarnea ? Or is it good to go |
For example it's still pointing at v3.0.0 but we're at 3.1.1 currently. I don't mind moving to it when it's set up, this is just for now to be consistent since all our docs are now in RTD |
Bump for review, @BeyondEvil / @ssbarnea |
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.
LGTM!
Merging this in with the understanding that the changelog will be deprecated when the release drafter is properly set up |
* remove phantomjs dependency (#424) * properly classify all npm dependencies (#425) * Move the changelog to read the docs (#423) * split plugin.py into smaller files (#427) * Implement the visible URL query parameter to control visibility of test results on page load. (#433) * enable control of test result visability via query params * Allow for redacting of environment table values (#431) * Disable Codecov (#480) * Disable Codecov * Disable pypy3 on mac * Add Tests.yml reusable workflow (#484) * Use the tests reusable workflow (#486) * Migrate to precommit.ci (#487) * Separate Nightly workflow (#488) Co-authored-by: Gleb Nikonorov <gleb.i.nikonorov@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
* remove phantomjs dependency (pytest-dev#424) * properly classify all npm dependencies (pytest-dev#425) * Move the changelog to read the docs (pytest-dev#423) * split plugin.py into smaller files (pytest-dev#427) * Implement the visible URL query parameter to control visibility of test results on page load. (pytest-dev#433) * enable control of test result visability via query params * Allow for redacting of environment table values (pytest-dev#431) * Disable Codecov (pytest-dev#480) * Disable Codecov * Disable pypy3 on mac * Add Tests.yml reusable workflow (pytest-dev#484) * Use the tests reusable workflow (pytest-dev#486) * Migrate to precommit.ci (pytest-dev#487) * Separate Nightly workflow (pytest-dev#488) Co-authored-by: Gleb Nikonorov <gleb.i.nikonorov@gmail.com> Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
Move the changelog to read the docs, since it would be a better user experience to have it with the rest of the documentation.