nushell/nu_scripts
1
1
Fork 0
mirror of https://github.com/nushell/nu_scripts.git synced 2024-09-11 13:45:56 +03:00
Code Issues Packages Projects Releases Wiki Activity
c352f26154
nu_scripts/make_release
History
Stefan Holderbach f2e35e153c
Script to generate the excerpt of the GH release (#566) 
* Script to generate the excerpt of the GH release

This will add a list of PR authors so they will be shown with a profile
image at the end of the GH release.

* Update make_release/release-note/gh-release-excerpt

Co-authored-by: Antoine Stevan <44101798+amtoine@users.noreply.github.com>

* Sort authors, feeks default release cycle

---------

Co-authored-by: Antoine Stevan <44101798+amtoine@users.noreply.github.com>
2023-08-23 00:42:15 +02:00
..
release-note Script to generate the excerpt of the GH release (#566) 2023-08-23 00:42:15 +02:00
20k_club.nu update default path in 20k_club 2023-06-30 06:33:23 -05:00
bump-version.nu add a script to bump the version of Nushell (#565) 2023-07-28 16:22:35 +02:00
gen-js-ext.nu replace occurences of str collect with str join (#436) 2023-04-03 08:47:25 -05:00
get_coverage.nu refactor: ✨ (#418) 2023-04-25 17:56:25 -05:00
nu_deps.nu update syntax for find-deps 2023-06-23 14:39:07 -05:00
nu_release.nu refactor: simplify the nu_release script (#540) 2023-07-08 12:47:40 +02:00
Readme.md rename date format to format date (#571) 2023-08-04 09:08:10 -05:00
this_week_in_nu_weekly.nu Update TWiN and since last release to 0.78 (#433) 2023-04-02 19:33:52 +02:00

Readme.md

The release process of Nushell

0. Release direct dependencies

Note


the following procedure is the same for nu-ansi-term and reedline and needs to be repeated

Warning


release nu-ansi-term before reedline and reedline before Nushell

Note


nu-ansi-term is typically released only when there are changes to publish. reedline is typically released on the same schedule as Nushell.

Note


in the following, dep denotes either the reedline or the nu-ansi-term remote e.g. https://github.com/nushell/reedline or git@github.com:nushell/nu-ansi-term, depending on the dependency being installed

  • bump the version (example with reedline and nu-ansi-term)
  • get the latest revision with git pull dep main
  • publish the crate with cargo publish (need to be a member of the publishing team)
  • tag the project with git tag v0.xx.0
  • push the release tag with git push dep main --tags
  • publish the release (include the (breaking) changes and take inspiration from the other releases)
  • bump the version on the Nushell side (example with reedline) (reference the release notes for courtesy)

1. Minor bump of the version (example)

  • in the repo of Nushell, run /path/to/nu_scripts/make_release/bump-version.nu
  • Also commit Cargo.lock AFTER running a Cargo command like cargo check --workspace

2. Tag the nushell repo

Warning


this is maybe the most critical step of the whole release process!! this step, once pushed to GitHub will trigger the release workflows.

Note


in the following, nushell will be used to pull and push to the nushell repo, e.g. the nushell remote would be https://github.com/nushell/nushell or git@github.com:nushell/nushell

  • get the latest version bump commit with git pull nushell main
  • run cargo build to check if it's ok and check last features
  • tag the project with git tag 0.xx.0
  • ⚠️ push the release tag to GitHub git push nushell main --tags ⚠️

👉 check the CI jobs
👉 check that there is the same number of targets compared to last release

3. Publish nu to crates.io

  • check the order of dependencies with nushell/nu_scripts/make_release/nu_deps.nu from the nushell repo
  • release the Nushell crates nushell/nu_scripts/make_release/nu_release.nu from the nushell repo

Note


if there is a new crate, you must add it to the github:nushell:publishing group (cargo owner --list)

Note


if a step fails

  • ask the owner to cargo owner --add github:nushell:publishing
  • edit the nu_release.nu script to start again where it failed
  • re-run the script

4. Publish the release note on the website

Note


the scripts have been written in such a way they can be run from anywhere

  • inspect the merged PRs to write changelogs with ./make_release/release-note/list-merged-prs nushell/nushell
  • reorder sections by priority, what makes the most sense to the user?
  • paste the output of ./make_release/release-note/list-merged-prs nushell/nushell --label breaking-change --pretty --no-author to the "Breaking changes" section
  • make sure breaking changes titles are clear enough
  • paste the output of ./make_release/release-note/get-full-changelog to the "Full changelog" section
  • mark as ready for review when uploading to crates.io
  • land when
    • fully uploaded to crates.io
    • before the GitHub release

5. Publish the release on GitHub

  • go to the draft release on the release page
  • grab the message of last one
  • wait for the website to publish the release (in the actions tab and on the website)
  • publish the release on GitHub

6. social media

  • post a status update on Discord
  • tweet about the new release

7. Create the next release note PR on the website

  • run ./make_release/release-note/create-pr 0.xx.0 ((date now) + 4wk | format date "%Y-%m-%d" | into datetime)

8. Bump the version as development

/path/to/nu_scripts/make_release/bump-version.nu --patch