Skip to content

Update asciidoctor requirement from 1.5.6.2 to 2.0.10 #1355

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

Closed

Conversation

dependabot-preview[bot]
Copy link

Updates the requirements on asciidoctor to permit the latest version.

Release notes

Sourced from asciidoctor's releases.

v2.0.10

Summary

This is a minor bug fix release that patches two regression, one when using the header_footer option with Asciidoctor.convert_file and one when the icons attribute is set to image. It also addresses a minor issue in the default stylesheet with excerpt blocks and passes a consistent set of arguments to SyntaxHighlighter#docinfo. The Japanese version of the README has been brought up to date thanks to @soishino and @wotsushi.

Distributions

Asciidoctor is also packaged for Fedora, Debian, Ubuntu, Alpine Linux, OpenSUSE, and Homebrew. You can use the system's package manager to install the package named asciidoctor.

Release meta

Released on: 2019-05-31 Released by: @mojavelinux Release beer: Elevated IPA by La Cumbre

Logs: resolved issues | full diff | issues resolved in 2.0.x (cumulative)

Changelog

Bug Fixes

  • fix Asciidoctor.convert_file to honor header_footer: false option when writing to file (#3316)
  • fix placement of title on excerpt block (#3289)
  • always pass same options to SyntaxHighlighter#docinfo, regardless of value of location argument
  • fix signature of SyntaxHighlighter#docinfo method (#3300)
  • when icons is set to image, enable image icons, but don't use it as the value of the icontype attribute (#3308)
Changelog

Sourced from asciidoctor's changelog.

== 2.0.10 (2019-05-31) - @mojavelinux

Bug Fixes::

  • fix Asciidoctor.convert_file to honor header_footer: false option when writing to file (#3316)
  • fix placement of title on excerpt block (#3289)
  • always pass same options to SyntaxHighlighter#docinfo, regardless of value of location argument
  • fix signature of SyntaxHighlighter#docinfo method (#3300)
  • when icons is set to image, enable image icons, but don't use it as the value of the icontype attribute (#3308)

// end::compact[] == 2.0.9 (2019-04-30) - @mojavelinux

Bug Fixes::

  • process multiple single-item menu macros in same line (#3279)
  • register images in catalog correctly (#3283)
  • rename AbstractNode#options method to AbstractNode#enabled_options so it doesn't get shadowed by Document#options (#3282)
  • don't fail to convert document if alt attribute is not set on block or inline image (typically by an extension)
  • fix lineno of source location on blocks that follow a detached list continuation (#3281)
  • assume inline image type is "image" if not set (typically by an extension)

== 2.0.8 (2019-04-22) - @mojavelinux

Bug Fixes::

  • restore background color applied to literal blocks by default stylesheet (#3258)
  • use portability constants (CC_ALL, CC_ANY) in regular expressions defined in built-in converters (DocBook5 and ManPage)
  • use portability constant (CC_ANY) in regular expression for custom inline macros
  • use smarter margin collapsing for AsciiDoc table cell content; prevent passthrough content from being cut off (#3256)
  • don't limit footnote ref to ASCII charset; allow any word character in Unicode to be used (#3269)

Improvements::

  • register_for methods accept arguments as symbols (#3274)
  • use Concurrent::Map instead of Concurrent::Hash in template converter
  • use module_function keyword to define methods in Helpers
  • move regular expression definitions to separate source file (internal change)

== 2.0.7 (2019-04-13) - @mojavelinux

Bug Fixes::

  • fix crash when resolving ID from text and at least one candidate contains an unresolved xref (#3254)
  • fix compatibility with Rouge 2.0

Improvements::

  • improve documentation for the -a CLI option; explain that @ modifier can be placed at end of name as alternative to end of value
  • move source for main API entry points (load, load_file, convert, convert_file) to separate files (internal change)
... (truncated)
Commits
  • 9302213 Release 2.0.10
  • eb685d9 add missing entry for #3110 to CHANGELOG [skip ci]
  • 8f83870 resolves #3316 fix Asciidoctor.convert_file to honor header_footer: false opt...
  • 66ae48d Synchronize Japanese README with English version (PR #3301)
  • e1beaa9 add missing entry to CHANGELOG for #3308 [skip ci]
  • c28ad27 refine emdash replacement
  • 2acdcec resolves #3308 honor image value for icons attribute
  • 1956a18 resolves #3300 fix signature of SyntaxHighlighter#docinfo method (PR #3303)
  • e272e40 always pass same options to SyntaxHighlighter#docinfo method
  • ae6440c add missing changelog entry for #3289 [skip ci]
  • Additional commits viewable in compare view

Dependabot will resolve any conflicts with this PR as long as you don't alter it yourself. You can also trigger a rebase manually by commenting @dependabot rebase.


Note: This repo was added to Dependabot recently, so you'll receive a maximum of 5 PRs for your first few update runs. Once an update run creates fewer than 5 PRs we'll remove that limit.

You can always request more updates by clicking Bump now in your Dependabot dashboard.

Dependabot commands and options

You can trigger Dependabot actions by commenting on this PR:

  • @dependabot rebase will rebase this PR
  • @dependabot recreate will recreate this PR, overwriting any edits that have been made to it
  • @dependabot merge will merge this PR after your CI passes on it
  • @dependabot squash and merge will squash and merge this PR after your CI passes on it
  • @dependabot cancel merge will cancel a previously requested merge and block automerging
  • @dependabot reopen will reopen this PR if it is closed
  • @dependabot close will close this PR and stop Dependabot recreating it. You can achieve the same result by closing it manually
  • @dependabot ignore this major version will close this PR and stop Dependabot creating any more for this major version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this minor version will close this PR and stop Dependabot creating any more for this minor version (unless you reopen the PR or upgrade to it yourself)
  • @dependabot ignore this dependency will close this PR and stop Dependabot creating any more for this dependency (unless you reopen the PR or upgrade to it yourself)
  • @dependabot use these labels will set the current labels as the default for future PRs for this repo and language
  • @dependabot use these reviewers will set the current reviewers as the default for future PRs for this repo and language
  • @dependabot use these assignees will set the current assignees as the default for future PRs for this repo and language
  • @dependabot use this milestone will set the current milestone as the default for future PRs for this repo and language
  • @dependabot badge me will comment on this PR with code to add a "Dependabot enabled" badge to your readme

Additionally, you can set the following in your Dependabot dashboard:

  • Update frequency (including time of day and day of week)
  • Pull request limits (per update run and/or open at any time)
  • Out-of-range updates (receive only lockfile updates, if desired)
  • Security updates (receive only security updates, if desired)

@dependabot-preview dependabot-preview bot added the dependencies Pull requests that update a dependency file label Dec 30, 2019
@HonkingGoose
Copy link
Contributor

HonkingGoose commented Dec 30, 2019

It's alive! 👻

Though we shouldn't yet merge it (#1354):

using asciidoctor version > 1.5.6.2 makes cross-reference links not work

@slonopotamus
Copy link
Contributor

It isn't clear what problem #1354 talks about. It is asciidoctor/asciidoctor-epub3#210? If yes, that bug was fixed in (already released) asciidoctor-epub3 1.5.0.alpha.10.

@jnavila
Copy link
Member

jnavila commented Jan 23, 2020

Not only this, we have to apply the whole migration cheatsheet to the book.

@HonkingGoose
Copy link
Contributor

@jnavila Do you want help with the migration?

I'm assuming we would migrate from the Legacy to the Modern syntax, as listed in the cheatsheet?

@jnavila
Copy link
Member

jnavila commented Jan 27, 2020

@HonkingGoose I'm working a script that could also be applied to all translations. I'll push the result in a dedicated branch for PR and let you know for review.

@HonkingGoose
Copy link
Contributor

Ah okay, I was thinking I could help go over it by changing it manually. But a script might be a lot faster. :) I'll look over it then when it's ready.

@Morganov
Copy link
Member

Morganov commented Feb 7, 2020

@jnavila could you share your script?

@jnavila
Copy link
Member

jnavila commented Feb 8, 2020

Add this task to the Rakefile file

  desc 'convert book for asciidoctor 2.x'
  task:migrate_asciidoctor2 do
	  root_files = Dir['ch*.asc'] + Dir['[ABC]*.asc'] + Dir[File.join ["book", "*.asc"]]
	  files = Dir[File.join ["book","*" , "sections","*.asc"]]+
		  root_files
	  files.each { |filename|
		  content = File.read(filename)
		  content.gsub!(/`(\*|a\/\*\*\/z)`|`(http|file:)|`\*\.c/,
				'`*`' => "`+*+`",
				'`a/**/z`' => "`+a/**/z+`",
				'`http' => "`\\http",
				'`file:' => "`\\file:",
				'`*.c' => "`+++*.c+++")
		  content.gsub!(/``(.*?)''/, '"`\1`"')
		  File.open(filename, "w") {|file| file.puts content }
	  }
	  content = File.read('progit.asc')
	  content.gsub!('.asc', '.adoc')
	  File.open('progit.asc', 'w') { |file| file.puts content }
	  root_files.each { |filename|
		  new_name = filename.gsub('.asc', '.adoc')
		  `git mv #{filename} #{new_name}`
	  }
	  `git mv index.asc index.adoc`
  end

This PR is not based on the script and was manually edited. But, diffing with the result of the script, I'd rather use the result from this task.

@Morganov
Copy link
Member

I think that asciidoctor version has to be updated at https://github.com/progit/progit2-pub/blob/master/Gemfile accordingly

@jnavila
Copy link
Member

jnavila commented Feb 23, 2020

@Morganov If I change the version in progit/progit2-pub, all the translated repos using these script must be translated to be compatible with asciidoctor v2.0.10. Right now the CJK (Chinese, Japanese, Korean) extensions of asciidoctor are incompatible with v2.0.10

@dependabot-preview
Copy link
Author

This pull request will no longer be automatically closed when a new version is found as this pull request was created by Dependabot Preview and this repo is using a version: 2 config file. You can close this pull request and let Dependabot re-create it the next time it checks for updates.

@ben ben closed this Jul 1, 2020
@dependabot-preview
Copy link
Author

OK, I won't notify you again about this release, but will get in touch when a new version is available.

If you change your mind, just re-open this PR and I'll resolve any conflicts on it.

@ben ben deleted the dependabot/bundler/asciidoctor-2.0.10 branch July 1, 2020 21:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
dependencies Pull requests that update a dependency file
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants