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

[Merged by Bors] - rename: no_lost_declarations to declarations_diff and short as default option #14105

Closed
wants to merge 5 commits into from

Conversation

adomani
Copy link
Collaborator

@adomani adomani commented Jun 24, 2024

This PR renames the no_lost_declarations script to declarations_diff, to better describe the effect of the script. It was originally intended as a script to make sure that "moving" PRs did not leave out any declaration, but is now used as a measure of the diff in declarations between PRs and master.

The other change it does is to make the short option the default, as this is the most commonly used.

Old New
./scripts/no_lost_declarations.sh short ./scripts/declarations_diff.sh
./scripts/no_lost_declarations.sh ./scripts/declarations_diff.sh long

Mostly, these changes are invisible, as this script is used almost exclusively by CI, but the intention is that the change conveys better what script does to a human.


Open in Gitpod

Copy link

github-actions bot commented Jun 24, 2024

PR summary 01cceba7e3

Import changes for modified files

No significant changes to the import graph

Import changes for all files
Files Import difference

Declarations diff

No declarations were harmed in the making of this PR! 🐙

You can run this locally as follows
## summary with just the declaration names:
./scripts/declarations_diff.sh <optional_commit>

## more verbose report:
./scripts/declarations_diff.sh long <optional_commit>

@grunweg
Copy link
Collaborator

grunweg commented Jul 11, 2024

Looks reasonable! What do you think about renaming to declarations_diff? (I find the latter more readable; if mostly CI runs this, one might as well use a readable name.)
Feel free to maintainer merge on my behalf when you considered this.

@adomani adomani changed the title rename: no_lost_declarations to decls_diff and short as default option rename: no_lost_declarations to declarations_diff and short as default option Jul 11, 2024
@adomani
Copy link
Collaborator Author

adomani commented Jul 11, 2024

Michael, thank you for the suggestion: I like it and I renamed the script to declarations_diff.

@grunweg
Copy link
Collaborator

grunweg commented Jul 11, 2024

Thanks!
maintainer merge

Copy link

🚀 Pull request has been placed on the maintainer queue by grunweg.

@grunweg grunweg added CI Modifies the continuous integration / deployment setup and removed maintainer-merge labels Jul 11, 2024
@mattrobball
Copy link
Collaborator

bors merge

@github-actions github-actions bot added the ready-to-merge This PR has been sent to bors. label Jul 11, 2024
mathlib-bors bot pushed a commit that referenced this pull request Jul 11, 2024
…default option (#14105)

This PR renames the `no_lost_declarations` script to `declarations_diff`, to better describe the effect of the script.  It was originally intended as a script to make sure that "moving" PRs did not leave out any declaration, but is now used as a measure of the diff in declarations between PRs and master.

The other change it does is to make the `short` option the default, as this is the most commonly used.

|Old|New|
|-|-|
|`./scripts/no_lost_declarations.sh short`|`./scripts/declarations_diff.sh`|
|`./scripts/no_lost_declarations.sh`|`./scripts/declarations_diff.sh long`|

Mostly, these changes are invisible, as this script is used almost exclusively by CI, but the intention is that the change conveys better what script does to a human.
@mathlib-bors
Copy link
Contributor

mathlib-bors bot commented Jul 11, 2024

Pull request successfully merged into master.

Build succeeded:

@mathlib-bors mathlib-bors bot changed the title rename: no_lost_declarations to declarations_diff and short as default option [Merged by Bors] - rename: no_lost_declarations to declarations_diff and short as default option Jul 11, 2024
@mathlib-bors mathlib-bors bot closed this Jul 11, 2024
@mathlib-bors mathlib-bors bot deleted the adomani/no_lost_declarations_to_decl_diff branch July 11, 2024 19:51
@adomani adomani mentioned this pull request Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CI Modifies the continuous integration / deployment setup ready-to-merge This PR has been sent to bors.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants