mbutrovich commented on code in PR #26845: URL: https://github.com/apache/datafusion/pull/26845#discussion_r4446905878
########## dev/release/README.md: ########## @@ -464,22 +481,37 @@ Caused by: Note: [`datafusion` formula](https://formulae.brew.sh/formula/datafusion) is [updated automatically](https://github.com/Homebrew/homebrew-core/pulls?q=is%3Apr+datafusion+is%3Aclosed), so no action is needed. -### 11. Sync Changelog and Version to main +### 12. Sync Changelog and Documentation to main + +The crate version is **not** synced back to `main`: `main` already carries the +next development version (such as `57.0.0-dev`) from +[Bump Version on main](#2-bump-version-on-main), and the released version +must never appear on `main`. -To sync changelog version and create PR against `main`: +Instead, create a PR against `main` that syncs the changelog and updates the +user-facing documentation to reference the new release: ```shell -git fetch apache && git checkout -b sync_change_log_version +git fetch apache && git checkout -b sync_change_log apache/main ``` -- Cherry-pick or patch the version updates from step 2 -- Cherry-pick or patch the changelog updates from step 5 -- Commit changes, `git commit -a -m 'Sync changelog and version to main'` -- Push to `origin/sync_change_log_version` +- Cherry-pick or patch the changelog updates from step 6 +- Update the crate version in the user-facing examples to the newly released + version, for example from `55.1.0` to `56.0.0`: + + ```shell + sed -i '' 's/55\.1\.0/56.0.0/' docs/source/download.md docs/source/user-guide/{crate-configuration,example-usage}.md + ``` Review Comment: > What if the update versions script had a flag to just update the user facing ones? The `sed -i ''` form in this step is BSD (macOS) syntax. GNU sed takes the backup suffix only when it's attached to `-i`, so on Linux the `''` becomes the script and `s/55\.1\.0/56.0.0/` is read as a file name. A docs-only mode in `update_datafusion_versions.py` would avoid that as well as the hand-maintained file list. -- 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]
