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

feat: Release rp235x-hal v0.3.0 #870

Closed
wants to merge 10 commits into from

Conversation

winksaville
Copy link
Contributor

Prepare to release pr235x-hal version 0.3.0

Copy link
Member

@9names 9names left a comment

Choose a reason for hiding this comment

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

You'll need to update the HAL version for the examples too, cargo won't let you compile things from path if the version specified isn't correct.

rp235x-hal = {path = "../rp235x-hal", version = "0.2.0", features = ["binary-info", "critical-section-impl", "rt", "defmt"]}

rp235x-hal/CHANGELOG.md Outdated Show resolved Hide resolved
@9names
Copy link
Member

9names commented Nov 4, 2024

If you look at https://github.com/rp-rs/rp-hal/blob/main/rp2040-hal/CHANGELOG.md, we've tried to include the PR # and the user who made the PR as well.
These are put into the github release notes, to ensure that folks are credited for their work.
An example of that is here: https://github.com/rp-rs/rp-hal/releases/tag/v0.10.2
If you have time to do those things it would be great. Thanks!

rp235x-hal/README.md Outdated Show resolved Hide resolved
@winksaville
Copy link
Contributor Author

You'll need to update the HAL version for the examples too, cargo won't let you compile things from path if the version specified isn't correct.

rp235x-hal = {path = "../rp235x-hal", version = "0.2.0", features = ["binary-info", "critical-section-impl", "rt", "defmt"]}

Fixed after changing Cargo.toml:

$ cargo build
    Updating crates.io index
     Locking 176 packages to latest compatible versions
      Adding ascii-canvas v3.0.0 (latest: v4.0.0)
      Adding bare-metal v0.2.5 (latest: v1.0.0)

..

   Compiling pio-parser v0.2.2
   Compiling rp235x-hal v0.3.0 (/home/wink/prgs/rpi-pico/myrepos/rp-hal/rp235x-hal)
   Compiling pio-proc v0.2.2
    Finished `dev` profile [unoptimized + debuginfo] target(s) in 17.20s
wink@3900x 24-11-04T21:58:15.831Z:~/prgs/rpi-pico/myrepos/rp-hal/rp235x-hal-examples (Release-rp235x-hal-v0.3.0)

@winksaville
Copy link
Contributor Author

If you look at https://github.com/rp-rs/rp-hal/blob/main/rp2040-hal/CHANGELOG.md, we've tried to include the PR # and the user who made the PR as well. These are put into the github release notes, to ensure that folks are credited for their work. An example of that is here: https://github.com/rp-rs/rp-hal/releases/tag/v0.10.2 If you have time to do those things it would be great. Thanks!

Is there a git log --format=xxx to get the "PR number" and "github/name" or some other way to generate that info?

winksaville and others added 8 commits November 4, 2024 14:51
    Create aliases build-arm run-arm build-riscv and run-riscv in
    .cargo/config.toml. With these defined you can now use the alias which
    will be converted to the full target name:

      cargo build-arm   -> cargo build --target thumbv8m.main-none-eabihf
      cargo run-arm     -> cargo run --target thumbv8m.main-none-eabihf
      cargo build-riscv -> cargo build --target riscv32imac-unknown-none-elf
      cargo run-risv    -> cargo run --target riscv32imac-unknown-none-elf

    Append --release parameter to do release builds and runs. For example:

      cargo run-riscv --release ->
             cargo run --target riscv32imac-unknown-none-elf --release

feat: Make it easier to specify target architecture

Create aliases build-arm run-arm build-riscv and run-riscv in
.cargo/config.toml. With these defined you can now use the alias which
will be converted to the full target name:

  cargo build-arm --bin blinky ->
  	cargo build --bin blinky --target=thumbv8m.main-none-eabihf
  cargo run-arm --bin blinky ->
  	cargo run --bin blinky --target=thumbv8m.main-none-eabihf
  cargo build-riscv --bin blinky ->
  	cargo build --bin blinky --target=riscv32imac-unknown-none-elf
  cargo run-risv --bin blinky ->
  	cargo run --bin blinky --target=riscv32imac-unknown-none-elf

Append --release parameter to do release builds and runs. For example:

  cargo run-risv --bin blinky --release ->
  	cargo run --bin blinky --target=thumbv8m.main-none-eabihf --release
Also, tweak the aliases and add dev and release modes with shorter names.
config.toml:
 * Use build-* rather than bld-*
 * Add a "custom" command example `rrr-blinky`

README.md:
 * Show "all" examples are created if `--bin` is not specified
 * Show the size differential between development and release profiles
 * Describe aliases at the end of Getting Started using build-riscv,
   run-riscv and rrr-blinky
@9names
Copy link
Member

9names commented Nov 4, 2024

I usually look at the closed PR list, match against merge commit messages
https://github.com/rp-rs/rp-hal/pulls?q=is%3Apr+is%3Aclosed

Apply some review suggestions, still need to add #PR and @user.
@winksaville winksaville force-pushed the Release-rp235x-hal-v0.3.0 branch from 4a71adf to 4e3070f Compare November 4, 2024 23:00
@winksaville
Copy link
Contributor Author

I've somehow messed this up, I'm closing it and starting over, sorry!

@winksaville winksaville closed this Nov 4, 2024
@winksaville winksaville deleted the Release-rp235x-hal-v0.3.0 branch November 4, 2024 23:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants