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

🍀 Proposal: dtm Configuration Enhancement: Single Profile Support #596

Closed
daniel-hutao opened this issue May 25, 2022 · 3 comments · Fixed by #655
Closed

🍀 Proposal: dtm Configuration Enhancement: Single Profile Support #596

daniel-hutao opened this issue May 25, 2022 · 3 comments · Fixed by #655
Assignees
Labels
enhancement New feature or request

Comments

@daniel-hutao
Copy link
Member

What Would You Like to Add? Why is This Needed?

Currently we need up to 3 config files:

  • config.yaml
  • variables.yaml
  • tools.yaml

This has a certain understanding cost for new users to get started. So I think it's necessary to support the integration of the 3 config files together to make it easier for new users to get started with dtm

Design

  • old config.yaml
varFile: variables.yaml
toolFile: tools.yaml
state:
  backend: local
  options:
    stateFile: devstream.state
  • old variables.yaml
foo: bar
  • old tools.yaml
tools:
- name: A-PLUGIN-NAME
  instanceID: default
  options:
    foo: bar

  • new config.yaml
---
# core config (please don't change this comment)
varFile: "" # If not empty, use the specified external variables config file
toolFile: "" # If not empty, use the specified external tools config file
state:
  backend: local
  options:
    stateFile: devstream.state

---
# variables config (please don't change this comment)
foo: bar

---
# plugins config (please don't change this comment)
tools:
- name: A-PLUGIN-NAME
  instanceID: default
  options:
    foo: bar
@daniel-hutao daniel-hutao self-assigned this May 25, 2022
@daniel-hutao daniel-hutao added the enhancement New feature or request label May 25, 2022
@daniel-hutao daniel-hutao changed the title 🍀 Proposal: dtm configuration enhancement: single profile support 🍀 Proposal: dtm Configuration Enhancement: Single Profile Support May 25, 2022
@IronCore864
Copy link
Member

Great design, approved.

Key points:

  • support both a single config and multiple config files;
  • var processing logic keeps the same.

@IronCore864
Copy link
Member

Thanks @prodanlabs for raising this issue. This feature would greatly reduce users' overhead when they first use DevStream.

@daniel-hutao
Copy link
Member Author

I'll do it right now!

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

Successfully merging a pull request may close this issue.

2 participants