Skip to content

Commit 9b65c2d

Browse files
committed
document releasing process in dev doc
1 parent ac9b669 commit 9b65c2d

File tree

2 files changed

+20
-0
lines changed

2 files changed

+20
-0
lines changed

Docs/source/developers/developers.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,3 +20,4 @@ Our Doxygen API documentation in classic formatting `is located here <../_static
2020
portability
2121
profiling
2222
documentation
23+
workflow
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
.. _developers-workflow:
2+
3+
Workflow
4+
========
5+
6+
Make a new Github release
7+
-------------------------
8+
9+
WarpX has one release per month. To make the release, you need to:
10+
11+
* Update the version number in all source files. There is a script for that, so you can do:
12+
13+
.. code-block:: sh
14+
cd Tools/
15+
./update_release.sh
16+
17+
* Merge ``dev`` branch into ``master`` branch.
18+
19+
* Click the `Draft a new release` button at https://github.com/ECP-WarpX/WarpX/releases and follow instructions.

0 commit comments

Comments
 (0)