From 98cd03b7a3085356b5f0f4fcdb7dc729b682f481 Mon Sep 17 00:00:00 2001 From: Eric Davies Date: Tue, 27 Jul 2021 13:51:04 -0500 Subject: [PATCH 0001/1288] fix(api): do not require Release name for creation Stop requiring a `name` attribute for creating a Release, since a release name has not been required since GitLab 12.5. --- gitlab/v4/objects/releases.py | 2 +- tests/functional/api/test_releases.py | 18 ++++++++++++++++++ 2 files changed, 19 insertions(+), 1 deletion(-) diff --git a/gitlab/v4/objects/releases.py b/gitlab/v4/objects/releases.py index 6216e4573..e27052db9 100644 --- a/gitlab/v4/objects/releases.py +++ b/gitlab/v4/objects/releases.py @@ -19,7 +19,7 @@ class ProjectReleaseManager(CRUDMixin, RESTManager): _obj_cls = ProjectRelease _from_parent_attrs = {"project_id": "id"} _create_attrs = RequiredOptional( - required=("name", "tag_name", "description"), optional=("ref", "assets") + required=("tag_name", "description"), optional=("name", "ref", "assets") ) _update_attrs = RequiredOptional( optional=("name", "description", "milestones", "released_at") diff --git a/tests/functional/api/test_releases.py b/tests/functional/api/test_releases.py index 81ae7def6..f409c2376 100644 --- a/tests/functional/api/test_releases.py +++ b/tests/functional/api/test_releases.py @@ -23,6 +23,24 @@ def test_create_project_release(project, project_file): assert release.description == release_description +def test_create_project_release_no_name(project, project_file): + unnamed_release_tag_name = "v2.3.4" + + project.refresh() # Gets us the current default branch + release = project.releases.create( + { + "tag_name": unnamed_release_tag_name, + "description": release_description, + "ref": project.default_branch, + } + ) + + assert len(project.releases.list()) >= 1 + assert project.releases.get(unnamed_release_tag_name) + assert release.tag_name == unnamed_release_tag_name + assert release.description == release_description + + def test_update_save_project_release(project, release): updated_description = f"{release.description} updated" release.description = updated_description From edf49a3d855b1ce4e2bd8a7038b7444ff0ab5fdc Mon Sep 17 00:00:00 2001 From: Eric Davies Date: Tue, 27 Jul 2021 14:36:55 -0500 Subject: [PATCH 0002/1288] docs(readme): move contributing docs to CONTRIBUTING.rst Move the Contributing section of README.rst to CONTRIBUTING.rst, so it is recognized by GitHub and shown when new contributors make pull requests. --- CONTRIBUTING.rst | 160 +++++++++++++++++++++++++++++++++++++++++++++++ README.rst | 160 +---------------------------------------------- 2 files changed, 162 insertions(+), 158 deletions(-) create mode 100644 CONTRIBUTING.rst diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst new file mode 100644 index 000000000..b065886f8 --- /dev/null +++ b/CONTRIBUTING.rst @@ -0,0 +1,160 @@ +Contributing +============ + +You can contribute to the project in multiple ways: + +* Write documentation +* Implement features +* Fix bugs +* Add unit and functional tests +* Everything else you can think of + +Development workflow +-------------------- + +Before contributing, please make sure you have `pre-commit `_ +installed and configured. This will help automate adhering to code style and commit +message guidelines described below: + +.. code-block:: bash + + cd python-gitlab/ + pip3 install --user pre-commit + pre-commit install -t pre-commit -t commit-msg --install-hooks + +Please provide your patches as GitHub pull requests. Thanks! + +Commit message guidelines +------------------------- + +We enforce commit messages to be formatted using the `conventional-changelog