diff options
Diffstat (limited to 'Docs/source')
| -rw-r--r-- | Docs/source/conf.py | 2 | ||||
| -rw-r--r-- | Docs/source/developers/developers.rst | 1 | ||||
| -rw-r--r-- | Docs/source/developers/workflow.rst | 19 |
3 files changed, 21 insertions, 1 deletions
diff --git a/Docs/source/conf.py b/Docs/source/conf.py index 380b08833..e8e5d96e2 100644 --- a/Docs/source/conf.py +++ b/Docs/source/conf.py @@ -59,7 +59,7 @@ author = 'WarpX collaboration' # built documents. # # The short X.Y version. -version = '19.10' +version = '20.01' # The full version, including alpha/beta/rc tags. release = '' diff --git a/Docs/source/developers/developers.rst b/Docs/source/developers/developers.rst index 777c2f77b..152359318 100644 --- a/Docs/source/developers/developers.rst +++ b/Docs/source/developers/developers.rst @@ -20,3 +20,4 @@ Our Doxygen API documentation in classic formatting `is located here <../_static portability profiling documentation + workflow diff --git a/Docs/source/developers/workflow.rst b/Docs/source/developers/workflow.rst new file mode 100644 index 000000000..c24185cd1 --- /dev/null +++ b/Docs/source/developers/workflow.rst @@ -0,0 +1,19 @@ +.. _developers-workflow: + +Workflow +======== + +Make a new Github release +------------------------- + +WarpX has one release per month. To make the release, you need to: + + * Update the version number in all source files. There is a script for that, so you can do: + + .. code-block:: sh + cd Tools/ + ./update_release.sh + + * Merge ``dev`` branch into ``master`` branch. + + * Click the `Draft a new release` button at https://github.com/ECP-WarpX/WarpX/releases and follow instructions. |