(v2.5.x) Deprecate 'headerFooter' in favour of 'standalone' #1162
Conversation
abelsromero
changed the title
|
Any idea why CI is not running for this branch? 🤔 It's set in the config |
|
I have no idea as well unfortunately. |
Nop, but should be easy 🤞 I'll check in my fork later. |
| @@ -86,7 +86,8 @@ private static List<String> getOptions(Map<String, Object> options) { | |||
| optionsAndAttributes.add(options.get(Options.ERUBY).toString()); | |||
| } | |||
|
|
|||
| if (options.containsKey(Options.HEADER_FOOTER)) { | |||
There was a problem hiding this comment.
I wonder if we can remove this entire method.
It seems like it's only called to produce some debug log message and in one test.
But apart from that AsciidoctorUtils.toAsciidoctorCommand() and AsciidoctorUtils.getOptions() does not seem to provide much value.
There was a problem hiding this comment.
If you mean toAsciidoctorCommand I think the same. Whenever I wanted to reproduce something in asciidoctor I could build the command directly, no need to check this debug. And it's a source of modularity issues.
Do you want to create an issue for that? It helps me to keep track of changes in multiple branches.
abelsromero
force-pushed
the
issue-1160-deprecate-headerFooter-with-standalone-for-2.5.x
branch
from
a51aa94
to
665660d
Compare
asciidoctorj-api/src/main/java/org/asciidoctor/OptionsBuilder.java
Outdated
Show resolved
Hide resolved
abelsromero
force-pushed
the
issue-1160-deprecate-headerFooter-with-standalone-for-2.5.x
branch
2 times, most recently
from
1be876f
to
e330544
Compare
* Replace headerFooter methods in OptionsBuild & Options * Added 'standalone' description to docs Other changes included: * Re-ordered options in docs to follow alphabetical order * Remove some unnecessary throws from tests * Add missing '@deprecated' to templateDir method * Add v2.5.x branch to run GH actions Fixes asciidoctor#1160
|
Thank you! |
abelsromero
deleted the
issue-1160-deprecate-headerFooter-with-standalone-for-2.5.x
branch
Kind of change
Description
What is the goal of this pull request?
Deprecate 'headerFooter' in favour of 'standalone'
Other changes included:
Related to #1161
How does it achieve that?
Simply add new method and change the use of the header_footer option in the internal map by standalone.
The old option is still accepted in the map, hence the check in
AsciidoctorUtils.Are there any alternative ways to implement this?
No
Are there any implications of this pull request? Anything a user must know?
No, no breaking change introduced.
Issue
If this PR fixes an open issue, please add a line of the form:
Fixes #1160
Release notes
Please add a corresponding entry to the file CHANGELOG.adoc