diff --git a/docs/Release_Guide/release_steps/close_release_issue.rst b/docs/Release_Guide/release_steps/close_release_issue.rst index 407dea4cbb..d9c28a41ed 100644 --- a/docs/Release_Guide/release_steps/close_release_issue.rst +++ b/docs/Release_Guide/release_steps/close_release_issue.rst @@ -1,8 +1,8 @@ Close Release Issue ------------------- -- Close the GitHub issue for creating this release. -- If necessary, create a new milestone for the next release (e.g. next vX.Y.Z (bugfix) release). -- If necessary, reassign any existing issues from the current to the next release. -- Edit the milestone for the current release by updating the *Due date* with the current date. -- Close the current milestone. +* Close the GitHub issue for creating this release. +* If necessary, create a new milestone for the next release (e.g. next vX.Y.Z (bugfix) release). +* If necessary, reassign any existing issues from the current to the next release. +* Edit the milestone for the current release by updating the *Due date* with the current date. +* Close the current milestone. diff --git a/docs/Release_Guide/release_steps/create_release_on_github.rst b/docs/Release_Guide/release_steps/create_release_on_github.rst index 69625ed861..2ddefa9988 100644 --- a/docs/Release_Guide/release_steps/create_release_on_github.rst +++ b/docs/Release_Guide/release_steps/create_release_on_github.rst @@ -1,9 +1,9 @@ Create Release on GitHub ------------------------ -- Go to Releases on GitHub and click 'Draft a new release' -- Set tag based on version starting with 'v', i.e. vX.Y.Z, vX.Y.Z-betaN or v.X.Y.Z -- Set branch value to main_vX.Y -- Choose release name (i.e. |projectRepo|-X.Y.Z, |projectRepo|-X.Y.Z-betaN or |projectRepo|-X.Y.Z) -- Add release notes from User's Guide to notes section -- (Skip unless PDF of User's Guide is ready) Attach User's Guide PDF +* Go to Releases on GitHub and click 'Draft a new release'. +* Set tag based on version starting with 'v', i.e. vX.Y.Z-betaN, vX.Y.Z-rcN or v.X.Y.Z +* Set branch value to main_vX.Y +* Choose release name (i.e. |projectRepo|-X.Y.Z-betaN, |projectRepo|-X.Y.Z-rcN or |projectRepo|-X.Y.Z) +* Add release notes from User's Guide to notes section. +* (Skip unless PDF of User's Guide is ready) Attach User's Guide PDF. diff --git a/docs/Release_Guide/release_steps/metplus/create_release_extra.rst b/docs/Release_Guide/release_steps/metplus/create_release_extra.rst index cc5435632a..921ddc3429 100644 --- a/docs/Release_Guide/release_steps/metplus/create_release_extra.rst +++ b/docs/Release_Guide/release_steps/metplus/create_release_extra.rst @@ -1,3 +1,5 @@ -* Add link to dtcenter.ucar.edu/dfiles/code/METplus/METplus_Data and add a note to - instruct users to use sub-directory corresponding to this release, i.e. v4.0.0) - +* Add link to `METplus_Data `_ + and add a note to instruct users to use sub-directory corresponding to this + release, i.e. v4.0.0) + +* Click on "Publish release". diff --git a/docs/Release_Guide/release_steps/metplus/update_version.rst b/docs/Release_Guide/release_steps/metplus/update_version.rst index 8968e02ac1..455b55d3eb 100644 --- a/docs/Release_Guide/release_steps/metplus/update_version.rst +++ b/docs/Release_Guide/release_steps/metplus/update_version.rst @@ -3,7 +3,10 @@ Update Version Number for Release Remove **-dev** from the version number: -* As of METplus v4.0.0-beta2, we are naming releases with X.Y.Z format even if Z is 0. -( As of METplus v3.0, the file containing the version number is located at docs/version (in earlier releases, the file was located at doc/version) +* As of METplus v4.0.0-beta2, we are naming releases with X.Y.Z format even if Z is 0. ( As of METplus v3.0, the file containing the version number is located at docs/version (in earlier releases, the file was located at doc/version) + * In the develop branch, the version should match the upcoming release with -dev added to the end like X.Y.Z-betaN-dev, i.e. 4.0.0-beta1-dev + * Remove **-dev** from the version number so that it matches the release you are creating. + +* Commit changes and push to GitHub. diff --git a/docs/Release_Guide/release_steps/update_dtc_website.rst b/docs/Release_Guide/release_steps/update_dtc_website.rst index 135c14f8f6..5c436d4521 100644 --- a/docs/Release_Guide/release_steps/update_dtc_website.rst +++ b/docs/Release_Guide/release_steps/update_dtc_website.rst @@ -1,9 +1,14 @@ Update DTC Website ------------------ -- Navigate to the downloads page for the |projectRepo| repository at www.dtcenter.org. -- Sign in to the Drupal interface and edit the Downloads page. -- Create a new *Software Release* for the newly released version. - - Select the release type (*Recommended* for official or bugfix releases or *Development* for development versions). If necessary, change previously *Recommended* versions to *Other*. - - Add links for release tar file, *User's Guide*, *Existing Builds and Docker*, and *Release Notes* section provide a direct link to the release-notes.html in the User's Guide. - - If creating a new official release, be sure to add a new *Existing Builds and Docker* page. + * Navigate to the downloads page for the |projectRepo| repository at www.dtcenter.org. + + * Sign in to the Drupal interface and edit the Downloads page. + + * Create a new *Software Release* for the newly released version. + + * Select the release type (*Recommended* for official or bugfix releases or *Development* for development versions). If necessary, change previously *Recommended* versions to *Other*. + + * Add links for release tar file, *User's Guide*, *Existing Builds and Docker*, and *Release Notes* section provide a direct link to the release-notes.html in the User's Guide. + + * If creating a new official release, be sure to add a new *Existing Builds and Docker* page. diff --git a/docs/Release_Guide/release_steps/update_release_notes.rst b/docs/Release_Guide/release_steps/update_release_notes.rst index c3bdb50565..9e273dae64 100644 --- a/docs/Release_Guide/release_steps/update_release_notes.rst +++ b/docs/Release_Guide/release_steps/update_release_notes.rst @@ -8,10 +8,12 @@ release. Open the following URL in a browser: https://github.com/dtcenter/|projectRepo|/issues -- Click on the Projects tab and select the project (under Repository) that +* Click on the Projects tab and select the project (under Repository) that corresponds to the release you are creating. -- Update the release-notes.rst file found in the User's Guide directory +* Update the release-notes.rst file found in the User's Guide directory. -- If you are creating a beta1 release, remove the previous version's release +* If you are creating a beta1 release, remove the previous version's release notes, i.e. for 3.0-beta1, remove all 2.Y notes and start the 3.0 section. + +* Commit changes and push to GitHub.