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

Build release tags on Travis #21846

Merged
merged 3 commits into from
May 14, 2017
Merged

Build release tags on Travis #21846

merged 3 commits into from
May 14, 2017

Conversation

tkelman
Copy link
Contributor

@tkelman tkelman commented May 13, 2017

this should hopefully result in automatic docs deployment to release-0.6

cc @mortenpi @MichaelHatherly is this right, will travis builds from a tag just do the right thing to gh-pages here? It looks like 0.5.1/0.5.2 might need to be built and committed manually to gh-pages for release-0.5?

@ararslan
Copy link
Member

ararslan commented May 13, 2017

Speaking of the 0.6 docs, I believe @mortenpi has been working on updating Documenter such that the new 0.6 syntax is highlighted appropriately. It would be great to get that into the docs build, however that needs to happen. (Sorry, a little OT)

@tkelman
Copy link
Contributor Author

tkelman commented May 13, 2017

Once there's a tagged release of Documenter available with that new feature, that gets upgraded by adjusting the version bounds in https://github.com/JuliaLang/julia/blob/master/doc/REQUIRE

@mortenpi
Copy link
Contributor

Documenter 0.10.1, tagged a few days ago, contains the highlighting fixes. There are a few code blocks in the manual that could use the new julia-repl highlighting as well.

As for tags, it should work, but all tags will get deployed to stable, including *-rcX ones, I believe. Documenter checks if TRAVIS_TAG is set and then simply deploys to stable. If the tag is a version number (matches Base.VERSION_REGEX), then it deploys to vX.Y.Z and release-X.Y directories as well. But RCs should match that regex as well.

I think this is too simplistic for the base docs. Workaround could be to only enable exactly v0.6.0 branch on that branch. But in general having RC docs deployed would be nice as well, so I think this needs a bit of refinement on Documenter's end.

0.5 docs are still on Sphinx, right? In that case Documenter can't really help. It seems that @MichaelHatherly was pushing those manually if one looks at the gh-pages commit history.

@tkelman
Copy link
Contributor Author

tkelman commented May 14, 2017

It's fine for now, since release-0.6 is the only branch using Documenter that we'll be tagging anything off of for a bit. release-0.5 still uses sphinx, yes. Guess I should manually build the docs and commit the html files for 0.5.2 then.

By the time we tag an 0.7.0-alpha it would be useful to have something a bit cleverer, to avoid stable alternating between 0.7 prerelease tags vs maybe concurrent 0.6.x backport tags.

@mortenpi
Copy link
Contributor

There will not be any more RCs for 0.6? With this the next RC would overwrite the 0.5 stable docs.

@tkelman
Copy link
Contributor Author

tkelman commented May 14, 2017

Oh, yes there will be an rc2 shortly. Almost stable, though guess we could tighten a regex somewhere and only push to stable for tags without any prerelease annotations?

@mortenpi
Copy link
Contributor

Dropping the (-\S*)? bit in .travis.yml ought to work as well, I guess? That way we don't build docs here for the -rc2 tag.

@tkelman
Copy link
Contributor Author

tkelman commented May 14, 2017

I was thinking it would be worth deploying prereleases to their respective release-x.y sections, but skipping them works for now

@mortenpi
Copy link
Contributor

Agreed that that is how it would ideally work, but that would require some changes to deploydocs, and I don't want to block the 0.6 release schedule 😄

Although, perhaps release-x.y should be for full releases only. I am thinking how should one handle a hypothetical v0.6.1-rc0 build. I feel that the release-0.6 shouldn't get overwritten until the actual v0.6.1 comes along. But it also implies that release-0.6 doesn't get created until v0.6.0 proper is tagged.

The RCs would still be in their dedicated vx.y.z-rcN directories, which is probably good enough.

this should hopefully result in automatic docs deployment to release-0.6

run travis on release tags but not pre-release tags
@tkelman tkelman merged commit 7a00007 into master May 14, 2017
@tkelman tkelman deleted the tk/build-tags-on-travis branch May 14, 2017 13:28
@ararslan
Copy link
Member

The latest docs build looks great! It appears that things are highlighted correctly now, but @mortenpi's changes to the default monospace font don't appear to be reflected.

tkelman added a commit that referenced this pull request May 14, 2017
this should hopefully result in automatic docs deployment to release-0.6

run travis on release tags but not pre-release tags

(cherry picked from commit 177156c)
ref #21846

Fix doctest line numbers

(cherry picked from commit e327b39)

Upgrade Documenter to v0.10.2

(cherry picked from commit e1f36c3)
@mortenpi
Copy link
Contributor

The font changes were not in the patch releases, we need v0.11.0 for that. But ideally we'd have those as well when 0.6.0 comes out.

@KristofferC
Copy link
Member

v0.11.0 is also the mobile improvements? Would be very nice to have that in as well.

@mortenpi
Copy link
Contributor

Yup. those too.

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.

4 participants