summaryrefslogtreecommitdiff
path: root/doc/release.md
diff options
context:
space:
mode:
authorPierre Sassoulas <pierre.sassoulas@gmail.com>2021-04-10 17:04:39 +0200
committerPierre Sassoulas <pierre.sassoulas@gmail.com>2021-04-10 17:21:41 +0200
commit9baf996c3e3e27208fe4f034744e278bba45adc1 (patch)
treea14cfc51606e2c9f85d3f68db16cfbc3dfa589d3 /doc/release.md
parent55953b3e433906855d92c42f630be9e4214553d0 (diff)
downloadastroid-git-9baf996c3e3e27208fe4f034744e278bba45adc1.tar.gz
Add prettier to pre-commit configuration
Diffstat (limited to 'doc/release.md')
-rw-r--r--doc/release.md43
1 files changed, 22 insertions, 21 deletions
diff --git a/doc/release.md b/doc/release.md
index 98443df6..2f029eab 100644
--- a/doc/release.md
+++ b/doc/release.md
@@ -1,14 +1,15 @@
# Releasing an astroid version
-So, you want to release the ``X.Y.Z`` version of astroid ?
+So, you want to release the `X.Y.Z` version of astroid ?
## Process
1. Preparation
1. Check if the dependencies of the package are correct
- 2. Update ``numversion`` in ``__pkginfo__``, ``dev_version`` should also be None when you tag.
+ 2. Update `numversion` in `__pkginfo__`, `dev_version` should also be None when you
+ tag.
3. Put the version numbers, and the release date into the changelog
- 5. Generate the new copyright notices for this release:
+ 4. Generate the new copyright notices for this release:
```bash
pip3 install copyrite
@@ -18,16 +19,16 @@ git --aliases=.copyrite_aliases . --jobs=8
# automatically
```
- 6. Submit your changes in a merge request.
+6. Submit your changes in a merge request.
-2. Make sure the tests are passing on Travis/GithubActions:
+7. Make sure the tests are passing on Travis/GithubActions:
https://travis-ci.org/PyCQA/astroid/
-3. Do the actual release by tagging the master with ``astroid-X.Y.Z`` (ie ``astroid-1.6.12``
+8. Do the actual release by tagging the master with `astroid-X.Y.Z` (ie `astroid-1.6.12`
for example).
-
-Until the release is done via Travis or github actions on tag, run the following commands:
+Until the release is done via Travis or github actions on tag, run the following
+commands:
```bash
git clean -fdx && find . -name '*.pyc' -delete
@@ -41,32 +42,32 @@ twine upload dist/*
### New branch to create for major releases
-The master branch will have all the new features for the ``X.Y+1`` version
+The master branch will have all the new features for the `X.Y+1` version
-If you're doing a major release, you need to create the ``X.Y`` branch
-where we will cherry-pick bugs to release the ``X.Y.Z+1`` minor versions
+If you're doing a major release, you need to create the `X.Y` branch where we will
+cherry-pick bugs to release the `X.Y.Z+1` minor versions
### Milestone handling
-We move issue that were not done in the next milestone and block release only
-if it's an issue labelled as blocker.
+We move issue that were not done in the next milestone and block release only if it's an
+issue labelled as blocker.
### Files to update after releases
#### Changelog
-* Create a new section, with the name of the release ``X.Y.Z+1`` on the ``X.Y`` branch.
-* If it's a major release, also create a new section for ``X.Y+1.0`` on the master branch
+- Create a new section, with the name of the release `X.Y.Z+1` on the `X.Y` branch.
+- If it's a major release, also create a new section for `X.Y+1.0` on the master branch
-You need to add the estimated date when it is going to be published. If
-no date can be known at that time, we should use ``Undefined``.
+You need to add the estimated date when it is going to be published. If no date can be
+known at that time, we should use `Undefined`.
#### Whatsnew
-If it's a major release, create a new ``What's new in astroid X.Y+1`` document
-Take a look at the examples from ``doc/whatsnew``.
+If it's a major release, create a new `What's new in astroid X.Y+1` document Take a look
+at the examples from `doc/whatsnew`.
### Versions
-Update ``numversion`` to ``X.Y+1.0`` in ``__pkginfo__`` for ``master`` and to ``X.Y.Z+1`` for the ``X.Y`` branch.
-``dev_version`` should also be back to an integer after the tag.
+Update `numversion` to `X.Y+1.0` in `__pkginfo__` for `master` and to `X.Y.Z+1` for the
+`X.Y` branch. `dev_version` should also be back to an integer after the tag.