Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vshn/concierge-cli
Companion CLI for Concierge to bulk-manage repository projects.
https://github.com/vshn/concierge-cli
cli concierge gitlab python3 vshn-project-ignore
Last synced: about 2 months ago
JSON representation
Companion CLI for Concierge to bulk-manage repository projects.
- Host: GitHub
- URL: https://github.com/vshn/concierge-cli
- Owner: vshn
- License: bsd-3-clause
- Created: 2019-03-01T18:22:02.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2024-10-09T10:11:33.000Z (3 months ago)
- Last Synced: 2024-10-22T06:45:49.490Z (2 months ago)
- Topics: cli, concierge, gitlab, python3, vshn-project-ignore
- Language: Python
- Homepage: https://pypi.org/project/concierge-cli/
- Size: 133 KB
- Stars: 8
- Watchers: 6
- Forks: 1
- Open Issues: 19
-
Metadata Files:
- Readme: README.rst
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
Concierge-cli |latest-version|
==============================|checks-status| |tests-status| |health| |python-support| |license|
Companion CLI for `Concierge`_, the Configuration management & CI solution
for aligning your multitude of Git repositories. Allows you to bulk-manage
properties of your Git repository projects. Currently, GitLab is supported... |latest-version| image:: https://img.shields.io/pypi/v/concierge-cli.svg
:alt: Latest version on PyPI
:target: https://pypi.org/project/concierge-cli
.. |checks-status| image:: https://img.shields.io/github/workflow/status/vshn/concierge-cli/Checks/master?label=Checks&logo=github
:alt: GitHub Workflow Status
:target: https://github.com/vshn/concierge-cli/actions?query=workflow%3AChecks
.. |tests-status| image:: https://img.shields.io/github/workflow/status/vshn/concierge-cli/Tests/master?label=Tests&logo=github
:alt: GitHub Workflow Status
:target: https://github.com/vshn/concierge-cli/actions?query=workflow%3ATests
.. |health| image:: https://img.shields.io/codacy/grade/363c38ca95b941438b442afb64591892/master.svg
:target: https://www.codacy.com/app/VSHN/concierge-cli
:alt: Code health
.. |python-support| image:: https://img.shields.io/pypi/pyversions/concierge-cli.svg
:alt: Python versions
:target: https://pypi.org/project/concierge-cli
.. |license| image:: https://img.shields.io/pypi/l/concierge-cli.svg
:alt: Software license
:target: https://github.com/vshn/concierge-cli/blob/master/LICENSE.. _Concierge: https://hub.docker.com/r/vshn/concierge/
Why Should I Use This Tool?
---------------------------Concierge-cli helps you analyze and bulk-update the repository projects you
manage (e.g. set topics on projects, generate project lists for ModuleSync).Installation
------------From PyPI:
.. code-block:: console
$ pip install concierge-cli
**Note:** You need Python >= 3.6, otherwise your installation will not
succeed (`python-gitlab`_ v2.0.0 dropped support for older Pythons).
You can use Pipenv to work around this limitation:.. code-block:: console
$ pip install pipenv
$ pipenv shell --three
$ pip install concierge-cli.. _python-gitlab: https://pypi.org/project/python-gitlab/
Preparation
-----------You need an `access token`_ of a GitLab user to access resources through the
API. For groups and group membership this needs to be an administrator user.
You may also want to `disable notifications`_ of the user(s) you plan to
perform bulk updates on, to avoid sending out massive amounts of emails... _access token: https://gitlab.com/profile/personal_access_tokens
.. _disable notifications: https://gitlab.com/profile/notificationsSet the GitLab URI and TOKEN as environment variables (if you want to avoid
using the ``--token`` and/or ``--uri`` options):.. code-block:: console
$ export CONCIERGE_GITLAB_URI=https://git.example.com/
$ export CONCIERGE_GITLAB_TOKEN=Usage Patterns
--------------#. Manage `project topics`_
#. List projects by topic
#. List (and merge) merge requests by project
#. Manage `group membership`_ and permissions.. _project topics: https://docs.gitlab.com/ce/user/project/settings/
.. _group membership: https://docs.gitlab.com/ce/user/group/#add-users-to-a-groupManage topics
^^^^^^^^^^^^^List all projects (for a private GitLab) that have no topics yet:
.. code-block:: console
$ concierge-cli gitlab --uri https://git.vs.hn topics --empty
List all projects "foo" or similar in group "bar" or similar: (on GitLab.com)
.. code-block:: console
$ concierge-cli gitlab topics bar/foo --empty
Set topics on all those projects:
.. code-block:: console
$ concierge-cli gitlab topics bar/foo --empty --set-topic Puppet --set-topic Ansible
List all projects *with* topics now: (double-check)
.. code-block:: console
$ concierge-cli gitlab topics bar/foo
List projects
^^^^^^^^^^^^^Print a YAML list of all projects matching a topic:
.. code-block:: console
$ concierge-cli gitlab projects --topic Puppet
Update the list of modules Concierge manages with a specific configuration:
.. code-block:: console
$ concierge-cli gitlab projects --topic Puppet > configs/foo-bar/managed_modules.yml
$ git add -v configs/foo-bar/managed_modules.yml
$ git status && git commit -m 'Added ...' && git pushMerge requests
^^^^^^^^^^^^^^List of all merge requests of a project, optionally matching labels:
.. code-block:: console
$ concierge-cli gitlab mrs mygroup/myproject --label mylabel
Add ``--merge yes`` to trigger merging all found requests.
Group membership
^^^^^^^^^^^^^^^^List all groups where user is not yet a member of:
.. code-block:: console
$ concierge-cli gitlab groups --no-member my.user.name
Add user to all those groups:
.. code-block:: console
$ concierge-cli gitlab groups --no-member my.user.name \
--set-permission maintainerList a user's group memberships and permissions:
.. code-block:: console
$ concierge-cli gitlab groups my.user.name
Remove a user from selected groups:
.. code-block:: console
$ concierge-cli gitlab groups my.user.name \
--group-filter a-group-name \
--set-permission noneFound a bug? Need a new feature?
--------------------------------Please see our `Contribution Guide`_ if you want to help out!
.. _Contribution Guide:
https://github.com/vshn/concierge-cli/blob/master/CONTRIBUTING.md