| 1 |
.. _maintenance_process: |
| 2 |
|
| 3 |
Maintenance Process |
| 4 |
################### |
| 5 |
|
| 6 |
This section provide guidances and process to eventlet |
| 7 |
maintainers. They are mostly dedicated to Eventlet' core maintainers lead the |
| 8 |
life cycle of eventlet. |
| 9 |
|
| 10 |
Releases |
| 11 |
======== |
| 12 |
|
| 13 |
Here we describe the process we usually follow to |
| 14 |
process a new release. |
| 15 |
|
| 16 |
1. Create a github issue to track the release |
| 17 |
--------------------------------------------- |
| 18 |
|
| 19 |
The first step will be to `open a new github issue`_ |
| 20 |
to warn other maintainers about our intention |
| 21 |
to produce a new release. They may want, or not, |
| 22 |
to land a specific patch to address a specific |
| 23 |
topic. This issue will allow them to raise their |
| 24 |
concerns. |
| 25 |
|
| 26 |
Here are some `previous examples of issues`_ specifically |
| 27 |
created to handle the release process. Usually we name this |
| 28 |
kind of issue with the following pattern "[release] eventlet <next-version-number>". |
| 29 |
|
| 30 |
Please add the `release` label to this issue. It would |
| 31 |
ease the tracking of works related to releases. |
| 32 |
|
| 33 |
2. Prepare the changelog |
| 34 |
------------------------ |
| 35 |
|
| 36 |
You now have to update the changelog by updating |
| 37 |
the `NEWS` file available at the root of eventlet the project. |
| 38 |
|
| 39 |
We would recommand to give the big picture of the changes |
| 40 |
landed by the coming version. The goal here is not to list |
| 41 |
each commit, but rather, to give a summarize of the significant |
| 42 |
changes made during this versions. |
| 43 |
|
| 44 |
Once your changes are done, then propose a pull request. |
| 45 |
|
| 46 |
Please add the `changelog` label to this pull request. It would |
| 47 |
ease the tracking of works related to releases. |
| 48 |
|
| 49 |
If you want, you can use the issue previously created to list |
| 50 |
each commits landed in this new version. Here is an example https://github.com/eventlet/eventlet/issues/897. |
| 51 |
|
| 52 |
3. Create the tag |
| 53 |
----------------- |
| 54 |
|
| 55 |
Once the changelog patch is merged, then we are now |
| 56 |
able to produce the new corresponding tag, here are the |
| 57 |
commands we use to do that: |
| 58 |
|
| 59 |
```bash |
| 60 |
$ git fetch origin # get the latest updates from the remote repo |
| 61 |
$ git tag -s vX.Y.Z origin/master # create a signed tag where X.Y.Z correspond to the version you are eager to produce |
| 62 |
$ git push origin --tags |
| 63 |
``` |
| 64 |
|
| 65 |
Do not hesitate to provide the list of changes in the tags message. |
| 66 |
Here is an example https://github.com/eventlet/eventlet/releases/tag/v0.34.3 |
| 67 |
You can simply reuse the changelog you made previously. |
| 68 |
|
| 69 |
Alternatively, the Github UI also allow you creating tags. |
| 70 |
|
| 71 |
4. Final checks |
| 72 |
--------------- |
| 73 |
|
| 74 |
Pushing the previous will produce a new build. This |
| 75 |
build will generate our release and will push this |
| 76 |
new version to Pypi. |
| 77 |
|
| 78 |
You should ensure that this new version is now |
| 79 |
well available on Pypi https://pypi.org/project/eventlet/#history. |
| 80 |
|
| 81 |
Your tag should be listed there https://github.com/eventlet/eventlet/tags. |
| 82 |
|
| 83 |
5. Close the issue |
| 84 |
------------------ |
| 85 |
|
| 86 |
If the previous steps were successful, then you can |
| 87 |
now update the Github issue that you previously created. |
| 88 |
|
| 89 |
I'd recommend to put a comment with the pypi link and the tag link |
| 90 |
like there https://github.com/eventlet/eventlet/issues/875#issuecomment-1887435752. |
| 91 |
|
| 92 |
You can now close this Github issue. |
| 93 |
|
| 94 |
.. _open a new github issue: https://github.com/eventlet/eventlet/issues/new |
| 95 |
.. _previous examples of issues: https://github.com/eventlet/eventlet/issues?q=label%3Arelease+is%3Aclosed |