Skip to content

Commit 2d12bc0

Browse files
authored
Release CLI v0.1.0 (#454)
As per [the CLI release guide](https://thebevyflock.github.io/bevy_cli/contribute/cli/release.html), this is the kick-off pull request that begins the release process for v0.1.0 of the CLI. ## For Reviewers Now's your chance to test out the CLI! You can (re-)install it with[^binstall]: ```sh cargo install --git https://github.com/TheBevyFlock/bevy_cli --branch release-cli-v0.1.0 --locked bevy_cli ``` [^binstall]: Once released, you can use `cargo-binstall` to install the pre-compiled binaries built by Github Actions. Once you have it installed, you can call `bevy` in the terminal: ```sh bevy --help ``` For more information, check out the documentation at <https://thebevyflock.github.io/bevy_cli/cli/index.html>. Some things that you should look for: 1. Do the features work correctly? 2. Do the features' behavior make sense? 3. Is there anything critical missing that _must_ be in the v0.1.0 release? 4. Is the documentation easy to read, understandable, and thorough? If you are satisfied with the CLI in its current state, leave an approval review. If you have a change that needs addressed before release, leave a "request changes" review. If you have a question, just leave a comment :) ## For Maintainers Hi, welcome! We've been cooking in the ~9 months since the CLI working group was started. As mentioned in the [release guide](https://thebevyflock.github.io/bevy_cli/contribute/cli/release.html), the CLI requires an approval from a core Bevy maintainer (or the project lead, hi Cart! 👋) before it can be published. Please take a few minutes to review the CLI in its current state and leave your thoughts on this PR. Some (additional) things to look for: 1. Is the CLI going in the right direction to eventually be made an official tool? 2. Does the CLI correctly advertise that it is an unofficial tool? 3. Are there any features that you would like to see in v0.2.0? 4. How much benefit does the CLI provide to the Bevy ecosystem? ## Open Questions 1. Right now the compiled CLI binary is installed as the name `bevy` or `bevy.exe`. Is this an issue because it could be misinterpreted as official, or is it not a problem because there is enough documentation saying it is unofficial? ## Thanks Although I'm the one opening the PR, I don't want to claim credit for the majority of the work put into the CLI. The CLI was primarily the result of months of effort by @TimJentzsch, who unfortunately for us is on vacation right now. I additionally want to thank @DaAlbrecht for several features and bug fixes, @janhohenheim and @benfrankel for being early adopters over at [`bevy_new_2d`](github.com/TheBevyFlock/bevy_new_2d), and everyone else who tried out the CLI, submitted issues, and made improvements. Thank you all!
1 parent 9fad68c commit 2d12bc0

File tree

21 files changed

+1615
-791
lines changed

21 files changed

+1615
-791
lines changed

CHANGELOG.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,19 @@ The format is based on [Keep a Changelog], and this project adheres to [Semantic
77
[Keep a Changelog]: https://keepachangelog.com/en/1.1.0/
88
[Semantic Versioning]: https://semver.org/spec/v2.0.0.html
99

10-
## Unreleased
10+
## v0.1.0-alpha.1 - 2025-05-23
1111

12-
**All Changes**: [`main`](https://github.com/TheBevyFlock/bevy_cli/commits/main)
12+
**All Changes**: [`cli-v0.1.0-alpha.1`](https://github.com/TheBevyFlock/bevy_cli/commits/cli-v0.1.0-alpha.1)
13+
14+
### Added
15+
16+
- `bevy new`: create new projects from a template using `cargo-generate` ([#2](https://github.com/TheBevyFlock/bevy_cli/pull/2))
17+
- [`bevy_new_minimal`](https://github.com/TheBevyFlock/bevy_new_minimal) is the default template if none is specified ([#80](https://github.com/TheBevyFlock/bevy_cli/pull/80))
18+
- There are shortcuts for templates from [TheBevyFlock](https://github.com/TheBevyFlock). For example, `-t 2d` uses [`bevy_new_2d`](https://github.com/TheBevyFlock/bevy_new_2d) ([#82](https://github.com/TheBevyFlock/bevy_cli/pull/82))
19+
- `bevy lint`: invoke the linter if `bevy_lint` is installed ([#4](https://github.com/TheBevyFlock/bevy_cli/pull/4))
20+
- `bevy build` and `bevy run`: build and run your program with Bevy-specific configuration ([#76](https://github.com/TheBevyFlock/bevy_cli/pull/76), [#103](https://github.com/TheBevyFlock/bevy_cli/pull/103), [#102](https://github.com/TheBevyFlock/bevy_cli/pull/102), [#120](https://github.com/TheBevyFlock/bevy_cli/pull/120))
21+
- You can use `bevy build web` and `bevy run web` to build and run your program for the web using Wasm.
22+
- Web binaries can be optimized with `wasm-opt` ([#206](https://github.com/TheBevyFlock/bevy_cli/pull/206), [#430](https://github.com/TheBevyFlock/bevy_cli/pull/430))
23+
- You can pass `--bundle` to pack all files needed for the web into a single folder ([#195](https://github.com/TheBevyFlock/bevy_cli/pull/195))
24+
- `bevy completions`: generate terminal auto-complete scripts for a variety of shells ([#265](https://github.com/TheBevyFlock/bevy_cli/pull/265))
25+
- The CLI can be configured with `[package.metadata.bevy_cli]` ([#331](https://github.com/TheBevyFlock/bevy_cli/pull/331), [#355](https://github.com/TheBevyFlock/bevy_cli/pull/355), [#351](https://github.com/TheBevyFlock/bevy_cli/pull/351))

0 commit comments

Comments
 (0)