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.

Sign up for GitHub

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

Jump to bottom

Small changes to ci tool #13137

Merged
merged 9 commits into from
Apr 30, 2024
Merged

Small changes to ci tool #13137

merged 9 commits into from
Apr 30, 2024

Conversation

BD103
Copy link
Member

@BD103 BD103 commented Apr 29, 2024 •
edited
Loading

Objective

  • Many of the items in the ci tool use pub(crate), which is functionally equivalent to pub when the crate is not a library.
  • A few items are missing documentation.

Solution

  • Make all pub(crate) items just pub.
    • pub is easier to type and less obscure, and there's not harm from this change.
  • Add / modify documentation on CI, Prepare, and PreparedCommand.

@BD103
chore: add more comments
3e0ff42
@BD103
refactor: move commands/mod.rs to commands.rs
3aaee2e 
This makes it easier to find `mod.rs`, since it will not be hidden alongside 10 other files.
@BD103
feat: use macro for declaring commands
dca3cca
@BD103
Revert "feat: use macro for declaring commands"
23f68bf 
This reverts commit dca3cca.
@BD103
chore: make a items pub
172892e 
`pub(crate)` is more of a hassle to write, especially since there is no `lib.rs`. No other crate can depend on this one, so there's no use restricting visibility.
@BD103
chore: document Prepare and associated items
57dc636
@BD103 BD103 added A-Build-System Related to build systems or continuous integration C-Code-Quality A section of code that is hard to understand or change labels Apr 29, 2024
@BD103 BD103 changed the title Ci tool refactors Small changes to ci tool Apr 29, 2024
alice-i-cecile
alice-i-cecile approved these changes Apr 29, 2024
View reviewed changes
Copy link
Member

@alice-i-cecile alice-i-cecile left a comment

Choose a reason for hiding this comment

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

  1. I like the docs.
  2. Slightly positive on using pub.
  3. Neutral to slightly negative on mod.rs -> command.rs but I super don't care.

MrGVSV
MrGVSV approved these changes Apr 29, 2024
View reviewed changes
Copy link
Member

@MrGVSV MrGVSV left a comment

Choose a reason for hiding this comment

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

Nice! Thanks for adding the docs, especially to the Prepare-related items.

Just one bikeshedding comment.

tools/ci/src/commands.rs Outdated Show resolved Hide resolved
@BD103
Copy link
Member Author

BD103 commented Apr 29, 2024

Ok, I'm think I'm going to revert the mod.rs change. Neither of you really liked the change, and I suppose the discoverability benefit is overshadowed by the inconsistency.

👍

@BD103
revert: 3aaee2e
cc75ff3 
Both reviewers disliked this change because it was inconsistent with Bevy and the Rust ecosystem as a whole.
@BD103
refactor: rustfmt
8219bbd
@BD103 BD103 added the S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it label Apr 29, 2024
@alice-i-cecile alice-i-cecile added this pull request to the merge queue Apr 30, 2024
Merged via the queue into bevyengine:main with commit abbaa39 Apr 30, 2024
28 checks passed
@BD103 BD103 deleted the ci-tool-refactors branch April 30, 2024 02:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@MrGVSV MrGVSV MrGVSV approved these changes

@alice-i-cecile alice-i-cecile alice-i-cecile approved these changes

Assignees
No one assigned
Labels
A-Build-System Related to build systems or continuous integration C-Code-Quality A section of code that is hard to understand or change S-Ready-For-Final-Review This PR has been approved by the community. It's ready for a maintainer to consider merging it
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@BD103 @alice-i-cecile @MrGVSV