Skip to content

Prevent github action workflow for changes on docs#872

Merged
Bachibouzouk merged 2 commits intodevfrom
feature/no_tests_docs
Apr 29, 2021
Merged

Prevent github action workflow for changes on docs#872
Bachibouzouk merged 2 commits intodevfrom
feature/no_tests_docs

Conversation

@Bachibouzouk
Copy link
Copy Markdown
Collaborator

It should prevent to have to wait for the test on the .py and coverage to pass if we change only the documentation .rst files
Leading to less waiting time and avoid using githubaction servers for nothing

Changes proposed in this pull request:

  • Your_changes

The following steps were realized, as well (if applies):

  • Use in-line comments to explain your code
  • Write docstrings to your code (example docstring)
  • For new functionalities: Explain in readthedocs
  • Write test(s) for your new patch of code (pytests, assertion debug messages)
  • Update the CHANGELOG.md
  • Apply black (black . --exclude docs/)
  • Check if benchmark tests pass locally (EXECUTE_TESTS_ON=master pytest)

For more information on how to contribute check the CONTRIBUTING.md.

@Bachibouzouk
Copy link
Copy Markdown
Collaborator Author

I will wait until the check have passed and will then change something in the README to see what happends then

@Bachibouzouk
Copy link
Copy Markdown
Collaborator Author

The problem then is that as the test never were triggered, we can only merge as administrators, but maybe it is still ok (I wanted to avoid the servers to run the tests if no files related to tests were changed anyway), what do you think @smartie2076 ?

Copy link
Copy Markdown
Collaborator

@smartie2076 smartie2076 left a comment

Choose a reason for hiding this comment

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

Its a good idea - we need to make sure, though, that the RTD tests (ie. compilation without warnings) is still run. As I have shown you, this is never the case on Windows locally, so if we do not test this we will actually collect a lot of warnings again.

Is a warning-free RTD compilation tested? Then you can merge as admin.

README.rst Outdated
Comment on lines +69 to +70
Test

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Suggested change
Test

@Bachibouzouk
Copy link
Copy Markdown
Collaborator Author

Is a warning-free RTD compilation tested? Then you can merge as admin.

The RTD compilation is done on the readthedocs side not from github actions (you can see that the doc ran for this current PR)

@smartie2076
Copy link
Copy Markdown
Collaborator

Is a warning-free RTD compilation tested? Then you can merge as admin.

The RTD compilation is done on the readthedocs side not from github actions (you can see that the doc ran for this current PR)

Ah, I thought this would only test that it can be compiled, not that it is compiled without warnings.

@Bachibouzouk
Copy link
Copy Markdown
Collaborator Author

Ah, I thought this would only test that it can be compiled, not that it is compiled without warnings.

The warning settings is in the .readthedocs.yml file under fail_on_warning: true

@Bachibouzouk Bachibouzouk force-pushed the feature/no_tests_docs branch from 9ca8067 to 01ea4ae Compare April 29, 2021 06:40
@Bachibouzouk Bachibouzouk merged commit 29af6b2 into dev Apr 29, 2021
@Bachibouzouk Bachibouzouk deleted the feature/no_tests_docs branch April 29, 2021 06:42
@smartie2076 smartie2076 mentioned this pull request May 31, 2021
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