[chore] Symlink README and duplicate LICENSE files#1859
Merged
Conversation
Drarig29
added
chores
Drarig29
marked this pull request as ready for review
September 23, 2025 15:40
Drarig29
requested review from
TalUsvyatsky,
daniel-mohedano and
drodriguezhdez
September 23, 2025 15:40
joepeeples
approved these changes
Sep 23, 2025
GabrielAnca
approved these changes
Sep 24, 2025
Drarig29
removed request for
TalUsvyatsky,
daniel-mohedano and
drodriguezhdez
September 24, 2025 08:54
AntoineDona
approved these changes
Sep 24, 2025
AntoineDona
left a comment
AntoineDona
left a comment
Contributor
There was a problem hiding this comment.
Looks good! just left one small comment 😉
This was referenced Sep 24, 2025
Merged
Merged
Merged
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What and why?
This PR prepares the release of all packages by duplicating the LICENSE file in every package, and it moves the root
README.mdto thepackages/datadog-cifolder then symlinks the root README to the package README.We can't symlink the other way around, because
npm packignores symlinks and would not include thepackages/datadog-ciREADME if it was a symlink. (see npm/cli#6746)I found another repo doing it: https://github.com/SBoudrias/Inquirer.js/blob/main/README.md
In GitHub, it will look like this:
How?
Copy licenses, update migration script, move the root readme, then run
ln -s packages/datadog-ci/README.md README.mdReview checklist