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 new flavor definition style, add bioinformatics flavor #4257

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

nwiltsie
Copy link
Contributor

This is a somewhat provocative PR that does two things - no hard feelings if you reject either or both changes.

Proposed Changes

  1. Add logic to respect descriptors and linters entries in flavor info returned from megalinter.flavor_factory.list_megalinter_flavors()
    • It feels very non-DRY to have each descriptor list all the flavors that include it, rather than having each flavor list the descriptors it includes.
    • I've added logic so that the flavor information dicts returned from list_megalinter_flavors() can include pre-filled descriptors and linters lists. That seems to allow a flavor to be completely defined within flavor_factory.py.
  2. Add a new bioinformatics flavor.

Based on local testing this seems to work as expected - the bioinformatics Dockerfile builds and runs appropriately, and bioinformatics appears as a new flavor (including being linked from each "This linter is available in the following flavors" section).

From the outside this seems like a cleaner way to define flavors, but I easily could be missing some critical reason why the current method is necessary.

Readiness Checklist

Author/Contributor

  • Add entry to the CHANGELOG listing the change and linking to the corresponding issue (if appropriate)
  • If documentation is needed for this change, has that been included in this pull request

Reviewing Maintainer

  • Label as breaking if this is a large fundamental change
  • Label as either automation, bug, documentation, enhancement, infrastructure, or performance

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant