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

Allow for a list of included modules (currently only excluded) #702

Closed
1 task done
freakyfelt opened this issue Dec 6, 2022 · 5 comments
Closed
1 task done

Allow for a list of included modules (currently only excluded) #702

freakyfelt opened this issue Dec 6, 2022 · 5 comments

Comments

@freakyfelt
Copy link

freakyfelt commented Dec 6, 2022

Checklist

Describe the problem you'd like to have solved

Currently the CLI tool only allows for an AUTH0_EXCLUDED list of modules, which means that splitting the config across multiple packages (e.g. when the pages are compiled and uploaded separately) requires enumerating the entire list of other modules to exclude. Instead it would be nice to have the ability to only include the pages module in this instance.

Describe the ideal solution

a new config option for AUTH0_INCLUDED is available that allows users of the CLI to specify a list of modules that will be processed for export/import.

Alternatives and current workarounds

Current workaround is to enumerate the entire list of modules and exclude the ones that are not relevant to the package.

Additional context

No response

@freakyfelt
Copy link
Author

Ah looks like this is already a mentioned proposal in #451

@willvedd
Copy link
Contributor

willvedd commented Dec 6, 2022

I can envision the general use case but do you mind explaining your personal use case? Doing so can help us better understand how folks use this tool.

But aside from that, I agree that this configuration option would be very helpful. Auth0 is constantly expanding its product offerings so its expected to be constantly updating an exclude list. The key is to clearly distinguish from AUTH0_EXCLUDED, I think the API language needs to be tweaked a bit, perhaps AUTH0_ONLY_INCLUDE or similar. And validation would need to be put in place to prevent their simultaneous usage.

This is something I expect us to deliver eventually, but cannot commit to specific timeframe.

@freakyfelt
Copy link
Author

We are looking to use a separate directory/monorepo package to build and deploy the login and error pages for auth0 aside from our standard auth0 configuration files with an eye toward splitting more configuration to other packages. Unfortunately that requires us to manually exclude the correct modules in each package instead of specifying which modules should be included.

|- packages/
  |- config/
    |- actions/
    |- ...
  |- pages/
    |- package.json
    |- dist/
    |- public/
    |- src/
    |- test/

@barzl
Copy link

barzl commented Dec 13, 2022

I would love to have the AUTH0_INCLUDED option.
We have a mix of clients, some are constant and deployed through the CLI tool, and some are dynamic and managed with management API.
So we need a way to explicitly state which clients should be updated via the CLI tool and ignore the rest.
This is better than fetch a list of all existing clients each CLI tool import operation and set the ones to ignore in CLI tool's config.

@willvedd
Copy link
Contributor

willvedd commented Feb 1, 2023

Good news! We've added this functionality in the 7.16.0 release via the AUTH0_INCLUDED_ONLY configuration property. Its usage is documented on the excluding from management and configuring the Deploy CLI pages.

Personally, this is something I've always wanted to add because it makes the tool easier to test. So thanks for the suggestion, it was the nudge we needed!

@willvedd willvedd closed this as completed Feb 1, 2023
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

3 participants