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

Release bevy_lint v0.1.0 #172

Merged
merged 10 commits into from
Nov 17, 2024
Merged

Release bevy_lint v0.1.0 #172

merged 10 commits into from
Nov 17, 2024

Conversation

BD103
Copy link
Member

@BD103 BD103 commented Nov 9, 2024

As per the release checklist, this PR kicks off the release for bevy_lint v0.1.0. Now is the time to assess its current features, review any outstanding changes or bugs, and run tests on real-world projects.

Once this pull request is approved by at least one core Bevy maintainer, I will merge it and create the Github release, then open a post-release PR setting up for v0.2.0-dev. Between the time this is merged and the post-release PR is merged there will be a feature freeze, preventing all other PRs related to bevy_lint from being merged. While I would appreciate freezing bevy_cli PRs as well for aesthetic reasons, it's not a requirement. :)

@BD103 BD103 added the A-Linter Related to the linter and custom lints label Nov 9, 2024
@BD103 BD103 added this to the `bevy_lint` 0.1.0 milestone Nov 9, 2024
@BD103
Copy link
Member Author

BD103 commented Nov 9, 2024

The following I'll add to the description of the Github release:

bevy_lint - v0.1.0

TODO: summary / description of new features

This release uses the nightly-2024-10-03 toolchain, based on Rust 1.83.0. You can install it from Git with the following commands:

rustup toolchain install nightly-2024-10-03 \
    --component rustc-dev \
    --component llvm-tools-preview

rustup run nightly-2024-10-03 cargo install \    
    --git https://github.com/TheBevyFlock/bevy_cli.git \
    --tag lint-v0.1.0 \
    --locked \
    bevy_lint

Added

  • Lint main_return_without_appexit to pedantic (#84)
  • Lint insert_event_resource to suspicious (#86)
  • Lint groups correctness, suspicious, complexity, performance, style, pedantic, restriction, and nursery (#98)
  • Lints panicking_query_methods and panicking_world_methods to restriction (#95)
  • Lint plugin_not_ending_in_plugin to style (#111)
  • Lint missing_reflect to restriction (#139)
  • Lint zst_query to restriction (#168)

@BD103 BD103 mentioned this pull request Nov 10, 2024
4 tasks
@alice-i-cecile
Copy link
Member

I couldn't find a list of the current lints and lint categories when exploring the docs, including information about which lints are on by default. This is a critical piece of information, and should be created / made very prominent before the initial release of bevy_lint.

@BD103
Copy link
Member Author

BD103 commented Nov 11, 2024

I couldn't find a list of the current lints and lint categories when exploring the docs, including information about which lints are on by default. This is a critical piece of information, and should be created / made very prominent before the initial release of bevy_lint.

Good call! I made a few changes that should make this clearer, though most further improvements would require larger changes that I'd rather push back until a later release. Take a look at my most recent 4 commits on this PR, and tell me if it's enough!

One of our dependencies was yanked, this avoids a warning when running the install command with --locked.
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.

I'm happy with the clarity here now :D

This fixes some errors that were temporarily enabled, then later disabled upstream.
@BD103
Copy link
Member Author

BD103 commented Nov 17, 2024

I've bumped the Rust toolchain version, as the old pinned nightly still had the unelided lifetime in signature errors enabled. I'm planning on releasing this afternoon or tomorrow!

@BD103 BD103 merged commit 8691821 into main Nov 17, 2024
8 checks passed
@BD103 BD103 deleted the 0.1.0-release branch November 17, 2024 16:29
BD103 added a commit that referenced this pull request Nov 17, 2024
@BD103 BD103 mentioned this pull request Nov 17, 2024
BD103 added a commit that referenced this pull request Nov 17, 2024
I missed these two changes in #172, I was too excited to press the merge
button!
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-Linter Related to the linter and custom lints
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants