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

Symlink repo LICENSE and README.md to module #161

Merged
merged 1 commit into from
Feb 8, 2024
Merged

Conversation

bufdev
Copy link
Member

@bufdev bufdev commented Feb 8, 2024

I noticed on https://buf.build/bufbuild/protovalidate that there was no README.md. This is better than nothing - the Buf Logo at the top might break, but at least we'll have something here. We can make a custom readme in the future if we want.

This also symlinks LICENSE as opposed to copying it.

@rodaine
Copy link
Member

rodaine commented Feb 8, 2024

We had this originally but it messed up stuff with the managed modules not following symlinks, iirc. cc @unmultimedio

@bufdev
Copy link
Member Author

bufdev commented Feb 8, 2024

I think rsync should work, it has --copy-links set https://github.com/bufbuild/modules/blob/61f8683d3c95dbb3c65faecec8d21d0b547cd41d/scripts/fetch.sh#L48, @unmultimedio what do you think

@unmultimedio
Copy link
Member

Yeah that --copy-links option was added after we started managing protovalidate in the modules repo. I also think this should work.

@unmultimedio
Copy link
Member

I can manually test it, gimme a few mins I'll report back.

@unmultimedio
Copy link
Member

Confirmed, it should work fine:

➜  protovalidate git:(license-readme) rsync --archive --prune-empty-dirs --relative --copy-links --include-from="/Users/jfigueroa/dev/buf/modules/modules/static/bufbuild/protovalidate/rsync.incl" . ../../../tmp                        
➜  protovalidate git:(license-readme) tree ../../../tmp
../../../tmp
├── LICENSE
├── README.md
├── buf
│   └── validate
│       ├── expression.proto
│       ├── priv
│       │   └── private.proto
│       └── validate.proto
├── buf.lock
└── buf.yaml

4 directories, 7 files

Both README and LICENSE are present.

Copy link
Member

@rodaine rodaine left a comment

Choose a reason for hiding this comment

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

:shipit:

@bufdev bufdev merged commit 8a3d2c5 into main Feb 8, 2024
3 checks passed
@bufdev bufdev deleted the license-readme branch February 8, 2024 23:09
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.

3 participants