diff options
| author | Pierre Sassoulas <pierre.sassoulas@gmail.com> | 2022-03-12 08:45:17 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-03-12 08:45:17 +0100 |
| commit | 1622459e37ed5c908dc602bb4c77b8e7191a8bbe (patch) | |
| tree | 535ce98f4dcab1de74bd7e9d3af0757ec53d2cd1 /doc | |
| parent | e346d42e92499849eb5d75ca27a648e1ce411ec7 (diff) | |
| download | astroid-git-1622459e37ed5c908dc602bb4c77b8e7191a8bbe.tar.gz | |
Simplify hard to maintain copyright notice (#1441)
* Simplify hard to maintain copyright notice
git is the source of truth for the copyright, copyrite (the tool)
was taking exponentially longer with each release, and it's
polluting the code with sometime as much as 50 lines of names.
* Add a pre-commit hook to check the copyright notice
* Fix the existing file so they have a notice
* Fix the spacing after the copyright notice
* Add a script to generate the CONTRIBUTORS.txt
Co-authored-by: Daniël van Noord <13665637+DanielNoord@users.noreply.github.com>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/conf.py | 4 | ||||
| -rw-r--r-- | doc/release.md | 4 |
2 files changed, 6 insertions, 2 deletions
diff --git a/doc/conf.py b/doc/conf.py index 4aba59da..8c5a03af 100644 --- a/doc/conf.py +++ b/doc/conf.py @@ -1,3 +1,7 @@ +# Licensed under the LGPL: https://www.gnu.org/licenses/old-licenses/lgpl-2.1.en.html +# For details: https://github.com/PyCQA/astroid/blob/main/LICENSE +# Copyright (c) https://github.com/PyCQA/astroid/blob/main/CONTRIBUTORS.txt + # # Astroid documentation build configuration file, created by # sphinx-quickstart on Wed Jun 26 15:00:40 2013. diff --git a/doc/release.md b/doc/release.md index 1646e42f..8a885130 100644 --- a/doc/release.md +++ b/doc/release.md @@ -8,7 +8,7 @@ So, you want to release the `X.Y.Z` version of astroid ? 1. Check if the dependencies of the package are correct 2. Check the result (Do `git diff vX.Y.Z-1 ChangeLog` in particular). -3. Install the release dependencies `pip3 install pre-commit tbump` +3. Install the release dependencies `pip3 install -r requirements_test.txt` 4. Bump the version and release by using `tbump X.Y.Z --no-push`. 5. Push the tag. 6. Release the version on GitHub with the same name as the tag and copy and paste the @@ -21,7 +21,7 @@ So, you want to release the `X.Y.Z` version of astroid ? Move back to a dev version with `tbump`: ```bash -tbump X.Y.Z+1-dev0 --no-tag --no-push # You can interrupt during copyrite +tbump X.Y.Z+1-dev0 --no-tag --no-push # You can interrupt after the first step git commit -am "Upgrade the version to x.y.z+1-dev0 following x.y.z release" ``` |