Skip to content

Commit

Permalink
Modified format and a few additions
Browse files Browse the repository at this point in the history
  • Loading branch information
jprestop committed Jan 28, 2021
1 parent 61ff53a commit 26dacef
Show file tree
Hide file tree
Showing 6 changed files with 37 additions and 25 deletions.
10 changes: 5 additions & 5 deletions docs/Release_Guide/release_steps/close_release_issue.rst
Original file line number Diff line number Diff line change
@@ -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.
12 changes: 6 additions & 6 deletions docs/Release_Guide/release_steps/create_release_on_github.rst
Original file line number Diff line number Diff line change
@@ -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.
Original file line number Diff line number Diff line change
@@ -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 <https://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)

* Click on "Publish release".
7 changes: 5 additions & 2 deletions docs/Release_Guide/release_steps/metplus/update_version.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
17 changes: 11 additions & 6 deletions docs/Release_Guide/release_steps/update_dtc_website.rst
Original file line number Diff line number Diff line change
@@ -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.
8 changes: 5 additions & 3 deletions docs/Release_Guide/release_steps/update_release_notes.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.

0 comments on commit 26dacef

Please sign in to comment.