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

Chore: move scaffolding configuration to a single folder #10

Merged
merged 13 commits into from
Mar 31, 2022

Conversation

leventebalogh
Copy link
Collaborator

@leventebalogh leventebalogh commented Mar 29, 2022

What changed?
Created a .config/ folder in the scaffolded projects which is containing all the build and dev-tooling configuration that is needed to start working with the plugins. To make it more explicit I have left most of the configuration files in the root of the scaffolded project, but now they are extending the basic configuration living under ./.config. (Like this it is easier and safer to extend them I guess)

Why?
The main reason for experimenting with this was the need for being able to apply configuration updates to plugins more easily. It would be beneficial to provide a script which can update the configuration of previously scaffolded plugins - this could help us maintaining our plugin examples, and could also help plugin developers keeping their plugins up to date more easily.

Link to .config/README

@leventebalogh leventebalogh self-assigned this Mar 29, 2022
@leventebalogh leventebalogh requested a review from mckn March 29, 2022 13:57
Copy link
Collaborator

@jackw jackw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Really like where this is going @leventebalogh ! 🚀 👏

templates/common/.prettierrc.js Show resolved Hide resolved
templates/common/docker-compose.yaml Outdated Show resolved Hide resolved
templates/common/jest.config.js Outdated Show resolved Hide resolved
Copy link
Collaborator

@mckn mckn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this is great!! The only thing that I'm not super fond of is the naming of the folder. Would it make sense to call it .plugin, .build, .grafana or something a bit shorter`

@leventebalogh
Copy link
Collaborator Author

I think this is great!! The only thing that I'm not super fond of is the naming of the folder. Would it make sense to call it .plugin, .build, .grafana or something a bit shorter

@mckn Yea, sure! What would you say to .config? Or you find the term config/configuration a bit misleading?
I would probably not call it .build personally, because the term is often used to as a folder name for generated build outputs, but .plugin and .grafana can work 🤔

@mckn
Copy link
Collaborator

mckn commented Mar 30, 2022

.config works for me!

@leventebalogh leventebalogh marked this pull request as ready for review March 30, 2022 10:57
@mckn mckn self-requested a review March 31, 2022 09:04
Copy link
Collaborator

@mckn mckn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! Go go go

@leventebalogh leventebalogh force-pushed the leventebalogh/update-common-configuration branch from c7e19f4 to d44ef84 Compare March 31, 2022 09:14
@leventebalogh leventebalogh merged commit f21df10 into main Mar 31, 2022
@leventebalogh leventebalogh deleted the leventebalogh/update-common-configuration branch March 31, 2022 10:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

None yet

3 participants