This is an automated email from the ASF dual-hosted git repository. EmryZhang pushed a commit to branch fix/rc2-crate-identity in repository https://gitbox.apache.org/repos/asf/casbin-sqlx-adapter.git
commit 0d9b286b6ef3e72dc02032ee5575e9b2e577f1af Author: Zhangyanrui123 <[email protected]> AuthorDate: Tue Sep 29 00:37:27 2026 +0800 fix: identify the SQLx adapter crate as part of Casbin --- .github/scripts/test-release.sh | 2 +- .github/workflows/release.yml | 4 ++-- Cargo.toml | 6 +++++- README.md | 24 ++++++++++++++++-------- RELEASING.md | 8 ++++++++ 5 files changed, 32 insertions(+), 12 deletions(-) diff --git a/.github/scripts/test-release.sh b/.github/scripts/test-release.sh index 14f15ac..43ad356 100755 --- a/.github/scripts/test-release.sh +++ b/.github/scripts/test-release.sh @@ -58,7 +58,7 @@ commit() { # --- fixture repository ---------------------------------------------------- mkdir repo && cd repo git init -q -printf '[package]\nname = "sqlx-adapter"\nversion = "0.0.0"\nedition = "2018"\n' >Cargo.toml +printf '[package]\nname = "casbin-sqlx-adapter"\nversion = "0.0.0"\nedition = "2018"\n' >Cargo.toml echo 'fixture' >LICENSE git add . && commit 'fixture' diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index d4922aa..9c75c29 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -73,13 +73,13 @@ jobs: NOTES="$RUNNER_TEMP/notes.md" if [ "$IS_RC" = true ]; then cat >"$NOTES" <<EOF - Release candidate for sqlx-adapter $VERSION. **This is not an Apache release**; it is the source tarball for the Apache vote. + Release candidate for Apache Casbin SQLx Adapter (Incubating) $VERSION. **This is not an Apache release**; it is the source tarball for the Apache vote. Release manager: download \`$BASENAME.tar.gz\` and its \`.sha512\`, sign the tarball with your key from the Casbin KEYS file, stage all three files under \`dist/dev/incubator/casbin/\`, and start the vote. See RELEASING.md. EOF else cat >"$NOTES" <<EOF - sqlx-adapter $VERSION. + Apache Casbin SQLx Adapter (Incubating) $VERSION (crate: casbin-sqlx-adapter). The attached files are the voted source release, byte for byte as published at https://downloads.apache.org/incubator/casbin/sqlx-adapter-$VERSION-incubating/ (verify with https://www.apache.org/info/verification.html). The crate on crates.io is built from these sources. EOF diff --git a/Cargo.toml b/Cargo.toml index e6e1e6f..bf92b71 100644 --- a/Cargo.toml +++ b/Cargo.toml @@ -16,7 +16,7 @@ # under the License. [package] -name = "sqlx-adapter" +name = "casbin-sqlx-adapter" # Placeholder on purpose. The release workflow derives the real version from # the git tag (vX.Y.Z -> X.Y.Z) and substitutes it when it builds the source # archive and publishes the crate, so nothing in the tree has to be bumped. @@ -36,6 +36,10 @@ readme = "README.md" # when packaging from an extracted source archive where .gitignore does not apply. exclude = ["*.db", "*.db-wal", "*.db-shm"] +[lib] +# Preserve existing Rust imports when changing the registry package name. +name = "sqlx_adapter" + [dependencies] casbin = { version = "2.1.0", default-features = false } sqlx = { version = "0.9", default-features = false, features = ["macros"] } diff --git a/README.md b/README.md index ccd17ca..7be1259 100644 --- a/README.md +++ b/README.md @@ -17,18 +17,18 @@ specific language governing permissions and limitations under the License. --> -# sqlx-adapter +# Apache Casbin SQLx Adapter (Incubating) Apache Casbin (Incubating) is an effort undergoing incubation at the Apache Software Foundation (ASF), sponsored by the Apache Incubator PMC. Incubation is required of all newly accepted projects until a further review indicates that the infrastructure, communications, and decision making process have stabilized in a manner consistent with other successful ASF projects. While incubation status is not necessarily a reflection of the completeness or stability of the code, it does indicate [...] -[](https://crates.io/crates/sqlx-adapter) -[](https://docs.rs/sqlx-adapter) +[](https://crates.io/crates/casbin-sqlx-adapter) +[](https://docs.rs/casbin-sqlx-adapter) [](https://github.com/apache/casbin-sqlx-adapter/actions/workflows/ci.yml) [](https://codecov.io/gh/apache/casbin-sqlx-adapter) -sqlx-adapter is the [Sqlx](https://github.com/launchbadge/sqlx) adapter for [casbin-rs](https://github.com/apache/casbin-rs). With this library, Casbin can load policy from Sqlx supported database or save policy to it with fully asynchronous support. +casbin-sqlx-adapter is the [SQLx](https://github.com/launchbadge/sqlx) adapter for [casbin-rs](https://github.com/apache/casbin-rs). With this library, Casbin can load policy from a SQLx-supported database or save policy to it with fully asynchronous support. -Based on [Sqlx](https://github.com/launchbadge/sqlx), The current supported databases are: +Based on [SQLx](https://github.com/launchbadge/sqlx), the current supported databases are: - [MySQL](https://www.mysql.com/) - [PostgreSQL](https://github.com/lib/pq) @@ -54,24 +54,32 @@ Add the following to `Cargo.toml`: For MySQL: ```toml -sqlx-adapter = { version = "1", default-features = false, features = ["mysql", "runtime-tokio", "tls-native-tls"]} +casbin-sqlx-adapter = { version = "1.9", default-features = false, features = ["mysql", "runtime-tokio", "tls-native-tls"]} tokio = { version = "1.1.1", features = ["macros"] } ``` For PostgreSQL: ```toml -sqlx-adapter = { version = "1", default-features = false, features = ["postgres", "runtime-tokio", "tls-native-tls"]} +casbin-sqlx-adapter = { version = "1.9", default-features = false, features = ["postgres", "runtime-tokio", "tls-native-tls"]} tokio = { version = "1.1.1", features = ["macros"] } ``` For SQLite: ```toml -sqlx-adapter = { version = "1", default-features = false, features = ["sqlite", "runtime-tokio", "tls-native-tls"]} +casbin-sqlx-adapter = { version = "1.9", default-features = false, features = ["sqlite", "runtime-tokio", "tls-native-tls"]} tokio = { version = "1.1.1", features = ["macros"] } ``` +Starting with 1.9.0, the registry package name changes from `sqlx-adapter` to +`casbin-sqlx-adapter`. Replace the dependency key in Cargo.toml as shown above. +The library name remains `sqlx_adapter`, so existing Rust imports and the +`SqlxAdapter` type do not change. Existing versions of `sqlx-adapter` remain +available. Release candidates are for review and are not published to crates.io; +the new package and documentation links become available after release approval +and publication. + **Warning**: `tokio v1.0` or later is supported from `sqlx-adapter v0.4.0`, we recommend that you upgrade the relevant components to ensure that they work properly. The last version that supports `tokio v0.2` is `sqlx-adapter v0.3.0` , you can choose according to your needs. ## Configure diff --git a/RELEASING.md b/RELEASING.md index be0cc0e..8358dbc 100644 --- a/RELEASING.md +++ b/RELEASING.md @@ -31,6 +31,14 @@ built from exactly those bytes. ## 1. Release candidate +Starting with 1.9.0, the crate is named `casbin-sqlx-adapter`; the library target +remains `sqlx_adapter` to preserve Rust imports. Confirm the package name with +the project and ensure its crates.io publishing account can administer the new +crate. An unused name is not a reservation or proof of project control. Check +the packaged manifest, README installation examples and docs.rs links together. +Do not publish an unapproved candidate merely to reserve the name. The ASF +source archive prefix and distribution directory naming remain unchanged. + Pick the commit to release (CI green on `master`) and push an RC tag: ```bash --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
