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

Breaking release #713

Closed
11 tasks done
mortenpi opened this issue Apr 21, 2018 · 3 comments
Closed
11 tasks done

Breaking release #713

mortenpi opened this issue Apr 21, 2018 · 3 comments
Milestone

Comments

@mortenpi
Copy link
Member

mortenpi commented Apr 21, 2018

It looks like we're heading towards a breaking release. We should try doing as many breaking changes together as possible, to make our lives easier. Right now I can think of these (but additional suggestions are very welcome):

Additional non-coding tasks we need to do before we can release this:

  • Automated PRs against METADATA packages using Documenter.
  • Need to ANN this on Discourse, ideally a reasonable time before the release hits METADATA.

The automated PRs could just add an upper bound to Documenter's Pkg.add. We could also consider actually making the necessary fixes to make.jl etc.


We also need to tag the new packages:

  • DocumenterTools.jl
  • DocumenterMarkdown.jl
  • DocumenterLaTeX.jl
@mortenpi mortenpi added this to the BREAKING milestone Apr 21, 2018
@fredrikekre
Copy link
Member

The automated PRs could just add an upper bound to Documenter's Pkg.add. We could also consider actually making the necessary fixes to make.jl etc.

I think with we should recommend people to make a doc-build project in e.g. docs/Project.toml, and commit its Manifest.toml. That way one needs to explicitly call up to update Documenter.

@mortenpi
Copy link
Member Author

I would go with the middle ground and have user have a [compat] section in their Project.toml to fix the major version. That way they would still get bugfixes.

@mortenpi mortenpi modified the milestones: BREAKING, 0.20.0 Sep 19, 2018
@mortenpi
Copy link
Member Author

mortenpi commented Sep 25, 2018

TODO list for the mass PRs for setting upper bounds -- summarizing our discussion @fredrikekre:

  • (1) Draft the issue, PR and discourse PSA
  • (2) Gather a list of packages we need to PR and see what we need to do exactly.
  • (3) Create an issue on Documenter for tracking the PRs. We should also lock the conversation there and suggest that people subscribe to that issue to be notified when v0.20 is released. The only thing that should be posted there is the announcement that v0.20 has hit METADATA. Other conversation should happen here in Breaking release #713 (or Discourse).
  • (4) Make all the PRs. Make sure they refer to the issue created in (3).
  • (5) Also PR all the documentation-only repos we have. Probably manually.
  • (6) Post a Discourse PSA after the PRs have been done. So that in case we missed something or for private packages etc., people would also know what to do if they need to do it by hand.

lbenet pushed a commit to PerezHz/TaylorIntegration.jl that referenced this issue Oct 18, 2018
This is releated to aforthcoming breaking release 0.20; see 
JuliaDocs/Documenter.jl#861 and 
JuliaDocs/Documenter.jl#713
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants