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

More meta-programming for documentation and testing #771

Closed
15 tasks done
lowlighter opened this issue Jan 14, 2022 · 0 comments
Closed
15 tasks done

More meta-programming for documentation and testing #771

lowlighter opened this issue Jan 14, 2022 · 0 comments

Comments

@lowlighter
Copy link
Owner

lowlighter commented Jan 14, 2022

Currently the metrics repositories images are generated and hosted on my personal repository lowlighter/lowlighter but I'd like to move them here instead.

This is also the occasion for a refactoring of documentation, examples and testing.
The aim is to combine them all: examples will be used for both illustrative purposes and as test cases, and will also be reused in documentation.

Additionally, options will be directly visible from plugin documentation (rather than reading the metadata.yml) and will also contain whether the option is new (i.e. a beta feature).

  • Create an orphan branch examples
    • Auto-generate production workflow from examples.yml
    • Auto-generate tests workflows from examples.yml
    • Remove tests.yml
  • Migrate workflows steps from lowlighter/lowlighter to lowlighter/metrics
    • Plugins
    • Templates
    • Other
  • Auto-generate workflows examples
    • In plugins documentation
    • In templates documentation
  • Auto-generate options and typing
    • In plugins documentation
    • In templates documentation
  • Test whole ci to ensure it's not broken
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant