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

Upgrade doc/make.jl to introspect branch/tag names from git info #32823

Merged
merged 1 commit into from
Aug 8, 2019

Conversation

staticfloat
Copy link
Member

Note that this requires that the julia you're using to deploy the docs matches the current julia checkout.

Note that this requires that the julia you're using to deploy the docs
matches the current julia checkout.
@mortenpi
Copy link
Contributor

mortenpi commented Aug 7, 2019

Also needs TRAVIS_PULL_REQUEST = "false" when building on branches. It should be fine to just set it iff on CI -- the tag and branch checks should make sure that we only deploy on non-PR builds.

@staticfloat
Copy link
Member Author

What happens if TRAVIS_PULL_REQUEST is not set? I was planning on just only running make -C doc deploy when on master or release-*.

@mortenpi
Copy link
Contributor

mortenpi commented Aug 7, 2019

It won't deploy. If we already check for PRs, then TRAVIS_PULL_REQUEST could just always be set to false.

The only minor this is that deploydocs will also try to deploy when running make deploy locally then (because all the env.vars are now set; well, it will fail due to a missing DOCUMENTER_KEY most likely). But that's probably OK.. the average user is not expected to run make -C doc deploy anyway I think.

# encode things like branch, whether it's built on a tag, etc....
env_mappings = [
"TRAVIS_REPO_SLUG" => "JuliaLang/docs.julialang.org",
"TRAVIS_BRANCH" => Base.GIT_VERSION_INFO.branch,
Copy link
Contributor

@mortenpi mortenpi Aug 7, 2019

Choose a reason for hiding this comment

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

Suggested change
"TRAVIS_BRANCH" => Base.GIT_VERSION_INFO.branch,
"TRAVIS_BRANCH" => Base.GIT_VERSION_INFO.branch,
"TRAVIS_PULL_REQUEST" => "false",

@staticfloat
Copy link
Member Author

The only minor this is that deploydocs will also try to deploy when running make deploy locally then

Ah, I see. In that case, let's set TRAVIS_PULL_REQUEST to false within the buildbot configuration.

@staticfloat
Copy link
Member Author

I'm going to merge this, then we'll see if the build on master goes through properly. :D

@staticfloat staticfloat merged commit ad8cf8d into master Aug 8, 2019
@staticfloat staticfloat deleted the sf/doctor-mentor branch August 8, 2019 01:35
This was referenced Aug 25, 2019
KristofferC pushed a commit that referenced this pull request Aug 26, 2019
Upgrade `doc/make.jl` to introspect branch/tag names from git info

(cherry picked from commit ad8cf8d)
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.

3 participants