Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Added more content to METdatadb release guides, following model of ME… #927

Merged
merged 1 commit into from
May 17, 2021
Merged

Added more content to METdatadb release guides, following model of ME… #927

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions docs/Release_Guide/metdatadb_bugfix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,19 @@ METdatadb Bugfix Release
========================

.. |projectRepo| replace:: METdatadb
.. |projectName| replace:: |projectRepo|
.. |addTarfileStep| replace:: Link text should be the name of the release and the URL should be the release page that was just created under the GitHub Releases tab.

Create a new vX.Y.Z bugfix release from the main_vX.Y branch.

.. include:: release_steps/open_release_issue.rst
.. include:: release_steps/clone_project_repository.rst
.. include:: release_steps/checkout_main_branch.rst
.. include:: release_steps/create_release_feature_branch.rst
.. include:: release_steps/metdatadb/update_version_bugfix.rst
.. include:: release_steps/update_release_notes_bugfix.rst
.. include:: release_steps/merge_release_issue.rst
.. include:: release_steps/create_release_on_github.rst
.. include:: release_steps/metdatadb/create_release_extra.rst
.. include:: release_steps/common/update_dtc_website.rst
.. include:: release_steps/finalize_release_on_github_bugfix.rst
10 changes: 10 additions & 0 deletions docs/Release_Guide/metdatadb_development.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,20 @@ METdatadb Development Release
=============================

.. |projectRepo| replace:: METdatadb
.. |projectName| replace:: |projectRepo|
.. |addTarfileStep| replace:: Link text should be the name of the release and the URL should be the release page that was just created under the GitHub Releases tab.

Create a new vX.Y.Z-betaN or vX.Y.Z-rcN development release from the develop branch while working toward an official vX.Y.Z release.

.. include:: release_steps/open_release_issue.rst
.. include:: release_steps/clone_project_repository.rst
.. include:: release_steps/checkout_develop_branch.rst
.. include:: release_steps/create_release_feature_branch.rst
.. include:: release_steps/metdatadb/update_version.rst
.. include:: release_steps/update_release_notes_development.rst
.. include:: release_steps/merge_release_issue.rst
.. include:: release_steps/create_release_on_github.rst
.. include:: release_steps/metdatadb/create_release_extra.rst
.. include:: release_steps/common/update_dtc_website.rst
.. include:: release_steps/finalize_release_on_github_development.rst
.. include:: release_steps/metdatadb/update_version_on_develop.rst
14 changes: 14 additions & 0 deletions docs/Release_Guide/metdatadb_official.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,24 @@ METdatadb Official Release
==========================

.. |projectRepo| replace:: METdatadb
.. |projectName| replace:: |projectRepo|
.. |addTarfileStep| replace:: Link text should be the name of the release and the URL should be the release page that was just created under the GitHub Releases tab.

Create a new vX.Y.Z official release from the develop branch.

.. include:: release_steps/open_release_issue.rst
.. include:: release_steps/clone_project_repository.rst
.. include:: release_steps/checkout_develop_branch.rst
.. include:: release_steps/create_release_feature_branch.rst
.. include:: release_steps/metdatadb/update_version_official.rst
.. include:: release_steps/update_release_notes_official.rst
.. include:: release_steps/rotate_authorship.rst
.. include:: release_steps/merge_release_issue.rst
.. include:: release_steps/create_release_branch.rst
.. include:: release_steps/push_release_branch.rst
.. include:: release_steps/create_release_on_github.rst
.. include:: release_steps/metdatadb/create_release_extra.rst
.. include:: release_steps/common/update_dtc_website.rst
.. include:: release_steps/finalize_release_on_github_official.rst
.. include:: release_steps/metdatadb/update_version_on_develop.rst
.. include:: release_steps/update_docs_official.rst
3 changes: 3 additions & 0 deletions docs/Release_Guide/release_steps/metdatadb/create_release_extra.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
* If this is a development release, check the box that says "This is a pre-release"

* Click on "Publish release".
12 changes: 12 additions & 0 deletions docs/Release_Guide/release_steps/metdatadb/update_version.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
Update Version Number for Release
---------------------------------

Remove **-dev** from the version number:

* We are naming releases with X.Y.Z format even if Z is 0. (the file containing the version number is located at docs/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.
8 changes: 8 additions & 0 deletions docs/Release_Guide/release_steps/metdatadb/update_version_bugfix.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
Update Version Number for Release
---------------------------------

Update the version number for the bugfix release:

* For |projectRepo|, the file containing the version number is located at docs/version.
* If the current release is listed as X.Y.Z (major.minor.micro), the bugfix version should be X.Y.Z+1
(i.e. increment the micro value by 1: 1.1.0 becomes 1.1.1)
9 changes: 9 additions & 0 deletions docs/Release_Guide/release_steps/metdatadb/update_version_official.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
Update Version Number for Release
---------------------------------

Remove **-dev** from the version number:

* We are naming releases with X.Y.Z format even if Z is 0.
* The file containing the version number is located at docs/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.
20 changes: 20 additions & 0 deletions docs/Release_Guide/release_steps/metdatadb/update_version_on_develop.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
Update Version on Develop Branch
--------------------------------

Change |projectRepo|/docs/version value to the next release after this one with -dev added
to the end. Releases will loosely follow these names, but are subject to
change:

+-------------------+-----------------------+
| Release Version | New Develop Version |
+===================+=======================+
| X.Y.Z-beta1 | X.Y.Z-beta2-dev |
+-------------------+-----------------------+
| X.Y.Z-beta2 | X.Y.Z-beta3-dev |
+-------------------+-----------------------+
| X.Y.Z-beta3 | X.Y.Z-rc1-dev |
+-------------------+-----------------------+
| X.Y.Z-rc1 | X.Y.Z-dev |
+-------------------+-----------------------+
| X.Y.Z | (X+1).0.0-beta1-dev |
+-------------------+-----------------------+