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

Release Jekyll v3.2 #4891

Closed
12 tasks done
parkr opened this issue May 13, 2016 · 27 comments
Closed
12 tasks done

Release Jekyll v3.2 #4891

parkr opened this issue May 13, 2016 · 27 comments
Assignees
Milestone

Comments

@parkr
Copy link
Member

parkr commented May 13, 2016

This is a checklist for releasing v3.2.0.

/cc @jekyll/stability @jekyll/build @jekyll/ecosystem

@parkr parkr added this to the 3.2 milestone May 13, 2016
@envygeeks
Copy link
Contributor

Add Pathutil#cleanpath to that list because we have Pathutil in there now and I need to make sure it's completely backwards compatible.

@benbalter
Copy link
Contributor

Documentation for gem-based themes

https://jekyllrb.com/docs/themes/

@parkr
Copy link
Member Author

parkr commented May 13, 2016

https://jekyllrb.com/docs/themes/

HOW DID THAT GET THERE?! 😄

@envygeeks
Copy link
Contributor

@parkr @benbalter that's why I commented that the release of the documentation is part of a much larger issue, every time we update the site the beta documentation lands on there indiscriminately and it's led to quite a few people asking questions about unreleased features and being confused.

@benbalter
Copy link
Contributor

HOW DID THAT GET THERE?!

I wrote them!

@chrisfinazzo
Copy link
Contributor

In cases like this, would it be preferable to ask that changes to documentation land in a separate branch? Currently, everything goes straight to master and sometimes things aren't ready. Whether it gets tagged as beta, or something like {{feature}}-docs-vx where vx is the anticipated milestone for when it should be integrated.

This is probably too formal, curious to hear what @jekyll/documentation thinks.

@envygeeks
Copy link
Contributor

That's actually along the lines almost of what I was thinking. I was thinking that I could talk to @parkr about maybe adjusting the merge bot so he can add an extra flag to merge documentation into the latest stable branch and only release the latest stable branch onto the site, and then we could adjust the domain to do something like beta.jekyllrb.com for master (of which I would happily host if Github Pages can't work that way.)

@erlend-sh
Copy link
Contributor

I like how Ionic has implemented versioned docs in their Jekyll site:

http://ionicframework.com/docs/api/service/$ionicBackdrop/

I can see something like that working very well for jekyllrb.com as well, tough for Jekyll differentiating between "stable" and "beta" (or latest/nightly/dev etc) would probably suffice.

@envygeeks
Copy link
Contributor

@erlend-sh I always liked doing it that way but that might take a ticket of it's own to deal with as it's a decent sized job and would require some restructuring and optimization. I wonder if we couldn't also add documentation via Cucumber.io doesn't it do that same style documentation except through our cucumber files?

@chrisfinazzo
Copy link
Contributor

Has anyone pulled the default theme out to create a gem yet? If not, I'm game.

@ghost
Copy link

ghost commented May 22, 2016

@chrisfinazzo hi game, i'm dad sure, go ahead

@suriyaa
Copy link
Member

suriyaa commented May 22, 2016

👍

@chrisfinazzo
Copy link
Contributor

@jekyll/core Still WIP - need to figure out Rubocop errors - but it's a starting point

@parkr
Copy link
Member Author

parkr commented May 22, 2016

@chrisfinazzo I already did most of this! Sorry :/ I forgot to make the repo public.

@chrisfinazzo
Copy link
Contributor

chrisfinazzo commented May 22, 2016

Ack! Please push it when you're ready and integrate/replace as needed.

I want to do a separate gem for my own site (currently working through the nuances of Susy grids), so this wasn't a bad use of 20 minutes.

👋🏻 to @zellwk, his book is a great way to get started with it.

@parkr
Copy link
Member Author

parkr commented May 23, 2016

@chrisfinazzo I have the beginnings of it over here: https://github.com/jekyll/minima Finishing up in #4924.

@jekyllbot jekyllbot added the stale Nobody stepped up to work on this issue. label Jun 27, 2016
@envygeeks
Copy link
Contributor

Wrong ticket bud.

@jekyllbot jekyllbot removed the stale Nobody stepped up to work on this issue. label Jun 27, 2016
@parkr parkr self-assigned this Jun 29, 2016
@parkr
Copy link
Member Author

parkr commented Jul 15, 2016

Merged the last PR for theme stuff.. Off to the races. Going to cull the milestone by this weekend and get this shipped!

@parkr
Copy link
Member Author

parkr commented Jul 24, 2016

Thinking through some last-minute things here:

  • Should we upgrade to Rouge 2?
  • Should we upgrade to Liquid 4?

Releasing another beta now.

@vaughandroid
Copy link

vaughandroid commented Jul 25, 2016

@parkr I don't know about those specific libraries, or how good your test coverage is, but in my experience upgrading libraries is best done at the start of a release cycle rather than the end. Too much risk!

@AndorChen
Copy link

Yeah, Rouge 2 changes a lot, but it has a backwards-compatibility solution.

@budparr
Copy link

budparr commented Jul 25, 2016

@parkr Aside from any other considerations, but I think there are performance gains in Liquid 4 that would be welcome, and from this conversation it doesn't seem as though it would be a difficult change: Shopify/liquid#678

@benbalter
Copy link
Contributor

Should we upgrade to Rouge 2? Should we upgrade to Liquid 4?

I'm a big proponent of getting 3.2 out the door with its current scope, and then immediately scoping a small 3.3 if we're interested in those major bumps. Minor releases are cheap and we're not on a set schedule, so no harm in getting 3.3 out a month (or less) after 3.2. Fewer moving parts means fewer things that can break.

@parkr
Copy link
Member Author

parkr commented Jul 25, 2016

Thanks for the feedback! Seems small enough to do for a minor release, but should be done for 3.3, not 3.2. 😄

@dalanmiller
Copy link

@parkr I'd love to see Rouge 2 because our site uses a lot of Javascript template strings which weren't fixed until recently.

@parkr
Copy link
Member Author

parkr commented Jul 26, 2016

@dalanmiller We're going to have to punt on Rouge 2 until Jekyll 3.3. Too many moving parts. (Integrates into {% highlight %} and into kramdown, so both need to be compatible.) We'll ship 🔜 !

@parkr
Copy link
Member Author

parkr commented Jul 28, 2016

Done!!!!!! 🎉 🎊

@parkr parkr closed this as completed Jul 28, 2016
@jekyll jekyll locked and limited conversation to collaborators Jul 5, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests