rl-institut / multi-vector-simulator

Multi-vector Simulation Tool assessing and optimizing Local Energy Systems (LES) for the E-LAND project
GNU General Public License v2.0
21 stars 10 forks source link

Prevent github action workflow for changes on docs #872

Closed Bachibouzouk closed 3 years ago

Bachibouzouk commented 3 years ago

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:

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

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

Bachibouzouk commented 3 years ago

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

Bachibouzouk commented 3 years ago

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 ?

Bachibouzouk commented 3 years ago

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 commented 3 years ago

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 commented 3 years ago

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