Skip to content

Commit

Permalink
Write bevy_lint release checklist and changelog (#163)
Browse files Browse the repository at this point in the history
This PR lays down the framework for `bevy_lint`'s release process.

- It creates a release checklist, inspired by [the engine's release
checklist](https://bevyengine.org/learn/contribute/project-information/release-process/),
for publishing a new version of `bevy_lint`.
- It creates a changelog that allow users to refer to changes between
versions, based on [Keep a
Changelog](https://keepachangelog.com/en/1.1.0/). Large user-facing
changes should be documented here with each PR.

<details>
<summary>Old argument on switching to 0.0.1, convinced otherwise and
reverted</summary>

- Set `bevy_lint`'s version to `0.0.1-dev` instead of `0.1.0-dev`. This
is mainly because:
- `bevy_lint` will never be stable as long as `bevy` isn't stable, which
means no 1.0 for now.
- We cannot publish to <https://crates.io> because the project is not
yet official and #150.
- It would be strange if there were a series of minor 0.X releases
missing from <https://crates.io>.
- So instead we publish 0.0.X "alpha" releases, with corresponding
instability warnings, just on Github.

</summary>
  • Loading branch information
BD103 authored Oct 30, 2024
1 parent 346f171 commit bf0d951
Show file tree
Hide file tree
Showing 3 changed files with 139 additions and 69 deletions.
135 changes: 66 additions & 69 deletions Cargo.lock

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

22 changes: 22 additions & 0 deletions bevy_lint/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# Changelog

All notable user-facing changes to this project will be documented in this file.

The format is based on [Keep a Changelog], and this project adheres to [Semantic Versioning].

[Keep a Changelog]: https://keepachangelog.com/en/1.1.0/
[Semantic Versioning]: https://semver.org/spec/v2.0.0.html

## [Unreleased]

**All Changes**: [`17834eb...main`](https://github.com/TheBevyFlock/bevy_cli/compare/17834eb...main)

### Added

- Lint `main_return_without_appexit` to `pedantic` ([#84](https://github.com/TheBevyFlock/bevy_cli/pull/84))
- Lint `insert_event_resource` to `suspicious` ([#86](https://github.com/TheBevyFlock/bevy_cli/pull/86))
- Lint groups `correctness`, `suspicious`, `complexity`, `performance`, `style`, `pedantic`, `restriction`, and `nursery` ([#98](https://github.com/TheBevyFlock/bevy_cli/pull/98))
- These are based directly on [Clippy's Lint Groups](https://doc.rust-lang.org/stable/clippy/lints.html).
- Lints `panicking_query_methods` and `panicking_world_methods` to `restriction` ([#95](https://github.com/TheBevyFlock/bevy_cli/pull/95))
- Lint `plugin_not_ending_in_plugin` to `style` ([#111](https://github.com/TheBevyFlock/bevy_cli/pull/111))
- Lint `missing_reflect` to `restriction` ([#139](https://github.com/TheBevyFlock/bevy_cli/pull/139))
Loading

0 comments on commit bf0d951

Please sign in to comment.