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

Prepare release 0.11.0 #145

Merged
merged 11 commits into from
Feb 21, 2023
Merged

Prepare release 0.11.0 #145

merged 11 commits into from
Feb 21, 2023

Conversation

ebkalderon
Copy link
Owner

@ebkalderon ebkalderon commented Feb 21, 2023

Added

  • Add [badges.maintenance] key to renderdoc and renderdoc-sys Cargo manifests.

Changed

  • Bump renderdoc crate version to version 0.11.0.
  • Bump renderdoc-sys crate version to version 1.0.0.
  • Simplify renderdoc_sys/generate_bindings.sh script.
  • Improve crate-level documentation and README descriptions.
  • Regenerate renderdoc-sys bindings using bindgen 0.64.0.
  • Update CHANGELOG.md.
  • Update copyright year in license file.

Removed

  • Remove renderdoc-sys from workspace default members.
  • Remove outdated [badges.circle-ci] keys from Cargo manifests.

Fixed

  • Gracefully handle RenderDoc absence in triangle.rs example.
  • Fix CI badge links in README.md and renderdoc-sys/README.md.

It's high time for this crate to commit to a 1.x semantic versioning
range. The likelihood this API will continue to churn is very low, and
if it ever does, compatibility guarantees should be conveyed explicitly
using the crate version number.
According to the upstream RenderDoc documentation, applications should
not panic if RenderDoc isn't loaded. Instead, they should handle its
absence gracefully and continue running. The `triangle.rs` example
should demonstrate this usage clearly.

We should update the `README.md` accordingly too, but considering a
total rewrite of this library is coming very soon, it probably isn't
worth investing too much time into that.
@ebkalderon ebkalderon self-assigned this Feb 21, 2023
@ebkalderon ebkalderon merged commit b75f7ea into master Feb 21, 2023
@ebkalderon ebkalderon deleted the prepare-release-0.11.0 branch February 21, 2023 02:24
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.

1 participant