Commit license-metadata.json to git and check it's correct in CI #133453
+345
−16
Conversation
This file contains 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
This will tell you if license-metadata.json is out of date.
rustbot
added
A-meta
This comment was marked as resolved.
This comment was marked as resolved.
|
Could not assign reviewer from: |
:) |
Kobzol
reviewed
Nov 26, 2024
| serde_json::from_str(&existing).with_context(|| { | ||
| format!("Failed to read existing license JSON at {}", dest.display()) | ||
| })?; | ||
| if existing_json != output { |
There was a problem hiding this comment.
Just thinking out loud: if we printed a diff here, it could help with inspecting licensing changes performed by PRs. But we already have some tidy checks for that, IIRC, so it's probably overkill.
|
Thank you, this was a pleasure to review. It's almost as if you're not doing this for the first time 😆 @bors r+ |
bors
added
S-waiting-on-bors
bors
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 27, 2024
…iaskrgr Rollup of 6 pull requests Successful merges: - rust-lang#132979 (use `--exact` on `--skip` to avoid unintended substring matches) - rust-lang#133248 (CI: split x86_64-msvc-ext job) - rust-lang#133449 (std: expose `const_io_error!` as `const_error!`) - rust-lang#133453 (Commit license-metadata.json to git and check it's correct in CI) - rust-lang#133457 (miri: implement `TlsFree`) - rust-lang#133493 (do not constrain infer vars in `find_best_leaf_obligation`) r? `@ghost` `@rustbot` modify labels: rollup
rust-timer
added a commit
to rust-lang-ci/rust
that referenced
this pull request
Nov 27, 2024
Rollup merge of rust-lang#133453 - ferrocene:check-license-metadata, r=Kobzol Commit license-metadata.json to git and check it's correct in CI This PR adds `license-metadata.json` to the root of the git repo, and changes `mingw-check` to check that the file is still up-to-date. By committing this file, we remove the need for developers to a) have reuse installed or b) run an expensive ~90 second analysis of the files on disk when they want generate the COPYRIGHT.html files which depend on this license metadata. The file will need updating whenever `REUSE.toml` changes, or when git submodules are added, or when git submodules change their license information (as detected by REUSE). You can now run: * `./x run collect-license-metadata` to update the `./license-metadata.json` file * `./x test collect-license-metadata` to test the `./license-metadata.json` file for correctness The comparison is done with two `serde_json::Value` objects, so the map objects they contain should ignore differences in ordering.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This PR adds
license-metadata.jsonto the root of the git repo, and changesmingw-checkto check that the file is still up-to-date.By committing this file, we remove the need for developers to a) have reuse installed or b) run an expensive ~90 second analysis of the files on disk when they want generate the COPYRIGHT.html files which depend on this license metadata.
The file will need updating whenever
REUSE.tomlchanges, or when git submodules are added, or when git submodules change their license information (as detected by REUSE).You can now run:
./x run collect-license-metadatato update the./license-metadata.jsonfile./x test collect-license-metadatato test the./license-metadata.jsonfile for correctnessThe comparison is done with two
serde_json::Valueobjects, so the map objects they contain should ignore differences in ordering.