tisonkun commented on code in PR #61: URL: https://github.com/apache/datasketches-rust/pull/61#discussion_r2657578496
########## RELEASE.md: ########## @@ -0,0 +1,301 @@ +<!-- + Licensed to the Apache Software Foundation (ASF) under one + or more contributor license agreements. See the NOTICE file + distributed with this work for additional information + regarding copyright ownership. The ASF licenses this file + to you under the Apache License, Version 2.0 (the + "License"); you may not use this file except in compliance + with the License. You may obtain a copy of the License at + + http://www.apache.org/licenses/LICENSE-2.0 + + Unless required by applicable law or agreed to in writing, + software distributed under the License is distributed on an + "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY + KIND, either express or implied. See the License for the + specific language governing permissions and limitations + under the License. +--> + +# Release process for Rust components + +**NOTES:** + +* This process covers major and minor releases only. Bug-fix releases, which increment the third digit, are performed on + an A.B.X branch and not on main, but otherwise follow a similar process. +* Some of these operations can be performed either on the Command-Line or in your IDE, whatever you prefer. + +## Preparation + +### Verify project health + +* Confirm correctness for: + * LICENSE + * NOTICE -- check for copyright dates + * README.md + * .asf.yaml + * .gitignore + * Cargo.toml -- ensure workspace metadata is correct + +* From Command Line or IDE: + * Run all checks: `cargo x lint` + * Run unit tests: `cargo x test` + * Run `cargo update` to ensure Cargo.lock is updated + <!-- TODO: * Run code coverage: `cargo llvm-cov --workspace` (target > 90%). --> + * Run tests on all platforms (see CI workflow) + * Confirm that documentation builds: `cargo doc --open` + * Confirm that all **temporary** branches are checked into main and/or deleted, both local and remote + * Confirm any new bug fixes have corresponding tests + * Check that all dependencies are at stable versions (no pre-release dependencies in Cargo.toml) + +### Verify release tooling + +* From Command Line at project root: + * Confirm GitHub repository is current and git status is clean + * Ensure you have publishing credentials configured: + * If not set: `cargo login` and enter your crates.io API token + * At major version releases, search for deprecated code and remove at **Major Versions** only: + * `grep -r "deprecated" --include="*.rs" src/` Review Comment: These are either trivial or should be checked with a workflow. We don't actually have a process to do Major Versions release or handling deprecated code. Let's add something until we really need it. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
