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

Add automatic tests for custom Antora extensions #546

Open
4 tasks
tbouffard opened this issue Apr 26, 2023 · 0 comments
Open
4 tasks

Add automatic tests for custom Antora extensions #546

tbouffard opened this issue Apr 26, 2023 · 0 comments

Comments

@tbouffard
Copy link
Member

We have an extension to change the way the versions are sorted and we will have a new one to handle latest/next version alias used by the DocSearch client in the theme (#520
Currently, we test the extensions "by hand" or by checking the preview running the "test sources content" #545

We could introduce unit tests to finely check the extension behavior.

Tasks

  • check the Antora documentation site and Zulip Chat for guidance about how to test Antora extensions
  • choose a test framework
  • decide if we keep "function" flavor or move to "class" flavor for the Antora Exension: it may be easier to test one form over the other
  • Bonus: check if the extension can be written using ESM style instead of CommonJS
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

1 participant