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

background-video doesn't honor imagesdir attribute like it should #356

Merged
merged 3 commits into from
Mar 20, 2020

Conversation

obilodeau
Copy link
Member

@obilodeau obilodeau commented Mar 17, 2020

Investigating what I thought was a problem with Asciidoctor, I realize that we are badly loading background-video local files.

Asciidoctor uses the media_uri method to lookup video files and we used it in the video template but for background-video this wasn't used.

This PR fixes that behavior.

Now, is this a backward-incompatible fix? It could break existing decks that relied on the wrong behavior. However, it was obviously broken and didn't follow what an Asciidoctor/AsciiDoc user would expect. I'm open to make this change part of a feature release but I would find it intense to bump a major version because of this. Guidance needed here.

Note

  • Title slide background-video is already correctly implemented
  • The first commit just exhibit the bug (I want to see it in travis), I have a local fix read to be pushed fix pushed

@obilodeau obilodeau added 🐛 bug ✔️ compliance 🎤 discussion Items that needs to be discussed with the broader Asciidoctor community labels Mar 17, 2020
This means that they now honor the :imagesdir: attribute like they should always have.
@obilodeau obilodeau added this to the 4.1.0 milestone Mar 19, 2020
@obilodeau obilodeau merged commit bc1f9a6 into asciidoctor:master Mar 20, 2020
@ggrossetie
Copy link
Member

Now, is this a backward-incompatible fix? It could break existing decks that relied on the wrong behavior. However, it was obviously broken and didn't follow what an Asciidoctor/AsciiDoc user would expect. I'm open to make this change part of a feature release but I would find it intense to bump a major version because of this. Guidance needed here.

It reminds me of: https://xkcd.com/1172/ (to a certain extend)
The behavior was defined by Asciidoctor and we should resolve images, audios and videos from the imagesdir directory, so we are fixing a bug.

Having said that you should put emphasis on the release note but I don't think we should do a major release. Otherwise, potentially every changes/bug fixes could potential break an existing workflow and thus requiring a major release.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🐛 bug ✔️ compliance 🎤 discussion Items that needs to be discussed with the broader Asciidoctor community
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants