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

Support top-level README and LICENSE at workspace root as defaults #3112

Closed
doriable opened this issue Jun 25, 2024 · 2 comments
Closed

Support top-level README and LICENSE at workspace root as defaults #3112

doriable opened this issue Jun 25, 2024 · 2 comments
Labels
Feature New feature or request

Comments

@doriable
Copy link
Member

Feature

Right now, in order to get a README and LICENSE to be pushed alongside a module, users need to symlink these files into their modules. This can be inconvenient.
With v2 modules, the buf.yaml configuration is designed to be at the top-level of a repository, alongside many of these common files. If a module does not have a README/buf.md and/or LICENSE explicitly defined and/or symlinked to the module root, should we support pushing the top-level files as a default?

I am proposing this for v2 buf.yaml workspaces only.

@bufdev
Copy link
Member

bufdev commented Jun 27, 2024

I'd say yes overall. Readme is a closer call, but as long as module-specific readme takes precedence, then ok.

@doriable
Copy link
Member Author

doriable commented Mar 4, 2025

This has been addressed in #3206

@doriable doriable closed this as completed Mar 4, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Feature New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants