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

allow deploy docs on schedule #1773

Merged
merged 2 commits into from
Mar 15, 2022
Merged

allow deploy docs on schedule #1773

merged 2 commits into from
Mar 15, 2022

Conversation

Ianlmgoddard
Copy link
Contributor

@Ianlmgoddard Ianlmgoddard commented Mar 8, 2022

This PR adds the deploy_on_schedule kwarg to deploydocs and deploy_folder. This lets the user deploy documentation from scheduled github actions.

I'm added some tests to check that the kwarg works as expected for deploy_folder. I couldn't see where the tests were for deploydocs but if tests exist for that function then I should probably add to them.

Also I think this a feature bump? unsure, any advice is appreciated.

closes #1772.

@Ianlmgoddard
Copy link
Contributor Author

I didn't add the kwarg for the deploy_folder dispatch on ::Travis. I don't think it's necessary?

d = Documenter.deploy_folder(cfg; repo="github.com/JuliaDocs/Documenter.jl.git",
devbranch="master", devurl="dev", push_preview=true,
deploy_on_schedule=false)
@test !d.all_ok
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Might be better to explicitly test that this failed because the event name schedule isn't accepted when deploy_on_schedule=false.

@fredrikekre
Copy link
Member

I think it shouldn't be configurable in Documenter. If you don't want doc builds for scheduled workflows that should be configured in the workflow file instead IMO.

@Ianlmgoddard
Copy link
Contributor Author

I think it shouldn't be configurable in Documenter.

Fair enough! I've redone the PR to be basically equivalent to #1554. Only real difference is the addition of a test to ensure all checks pass when the event is schedule.

@fredrikekre fredrikekre merged commit b6017ac into JuliaDocs:master Mar 15, 2022
@fredrikekre
Copy link
Member

Great, thank you!

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

Successfully merging this pull request may close these issues.

Allow docs build on schedule
3 participants