Skip to content

Preventing problems with git-scm for Asciidoctor 2 and version bump to ProGit2 book generation. #1516

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Closed
HonkingGoose opened this issue Oct 11, 2020 · 3 comments

Comments

@HonkingGoose
Copy link
Contributor

Incoming changes upstream ProGit2 English

  • Migration from Asciidoctor 1.5.6.2 to Asciidoctor 2.0.10 for the ProGit 2 book generation.
  • Potential ProGit 2 book minor version bump from 2.1.x -> 2.2.x (this is not yet fully decided yet)

Questions for git-scm.com

  1. The version of Asciidoctor that the book uses will change, is this a breaking change on your end?
  2. Would bumping the ProGit 2 minor version number cause problems on your end? I notice you reference edition 2 in the book2.rake script. Does that handle minor version changes automatically???
  3. Is there something else that I should know about to prevent problems on your end?

Reference for incoming change

You can see the work-in-progress pull request at progit/progit2#1373 to get a preview of incoming changes.

@peff
Copy link
Member

peff commented Oct 13, 2020

Thanks as usual for looping us in early on big changes. The bump to Asciidoctor 2.0.10 shouldn't be a problem; we're already using that version. So it's likely we may end up fixing any bugs if you make changes as part of the migration.

The edition field is our own internal value, to differentiate it from the 1st edition entries in our database. I don't think we look at any tags/releases from progit2 at all for the site content, and instead just always pull the latest tip of HEAD. So as long as we can continue pulling data from the same repo, I think we won't even notice the difference.

We do pull the ebook/pdf/etc links from the releases, but there we're just asking octokit for the latest release. We don't even look at the name or version number.

@HonkingGoose
Copy link
Contributor Author

So we're good to go, as-is. 😄
Thanks for the response! 👍

Do you want to keep this issue open until ProGit2 has done the Asciidoctor 2 migration or do you want to close it?

@peff
Copy link
Member

peff commented Oct 14, 2020

I'll close it; I don't expect problems, and if we do we can reopen (or make a new issue for the specific symptom).

@peff peff closed this as completed Oct 14, 2020
# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants