https://github.com/jwodder/dependalabels

Create GitHub PR labels used by Dependabot config
https://github.com/jwodder/dependalabels

dependabot github github-labels github-repository-management python

Last synced: about 1 month ago
JSON representation

Create GitHub PR labels used by Dependabot config

• Host: GitHub
• URL: https://github.com/jwodder/dependalabels
• Owner: jwodder
• License: mit
• Created: 2023-09-24T18:24:03.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-11-29T16:04:30.000Z (about 2 months ago)
• Last Synced: 2024-11-29T17:19:53.277Z (about 2 months ago)
• Topics: dependabot, github, github-labels, github-repository-management, python
• Language: Python
• Homepage:
• Size: 43 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
|repostatus| |ci-status| |license|

.. |repostatus| image:: https://www.repostatus.org/badges/latest/concept.svg

    :target: https://www.repostatus.org/#concept

    :alt: Project Status: Concept – Minimal or no implementation has been done

          yet, or the repository is only intended to be a limited example,

          demo, or proof-of-concept.

.. |ci-status| image:: https://github.com/jwodder/dependalabels/actions/workflows/test.yml/badge.svg

    :target: https://github.com/jwodder/dependalabels/actions/workflows/test.yml

    :alt: CI Status

.. |license| image:: https://img.shields.io/github/license/jwodder/dependalabels.svg

    :target: https://opensource.org/licenses/MIT

    :alt: MIT License

`GitHub `_

| `Issues `_

When setting up Dependabot_ to automatically create pull requests for

out-of-date dependencies, you have the option of specifying custom labels

to be applied to these PRs; however, if you forget to actually create the

labels in your repository, Dependabot won't create them for you, and so they

won't be used.

The ``dependalabels`` command provides a simple solution: it extracts the

custom labels from your ``dependabot.yml`` file and ensures that the labels all

exist in your GitHub repository.

.. _Dependabot: https://docs.github.com/en/code-security/dependabot

Installation

============

``dependalabels`` requires Python 3.10 or higher.  Just use `pip

`_ for Python 3 (You have pip, right?) to install it::

    python3 -m pip install git+https://github.com/jwodder/dependalabels.git

Usage

=====

::

    dependalabels [] []

``dependalabels`` operates on the Git repository at the specified path,

defaulting to the current directory.  The repository's ``origin`` remote must

point to a corresponding GitHub repository.  ``dependalabels`` reads

``.github/dependabot.yml`` at the root of the local repository and ensures that

each custom label listed therein exists in the GitHub repository.

``dependalabels`` predefines certain labels and gives them specific colors and

descriptions; all other labels are given random colors and empty descriptions.

Options

-------

-f, --force             If a predefined label already exists in the GitHub

                        repository, ensure its color and description have the

                        same values as used by ``dependalabels`` when creating

                        the label.

Authentication

--------------

``dependalabels`` requires a GitHub access token with appropriate permissions

in order to run.  Specify the token via the ``GH_TOKEN`` or ``GITHUB_TOKEN``

environment variable (possibly in an ``.env`` file), by storing a token with

the ``gh`` or ``hub`` command, or by setting the ``hub.oauthtoken`` Git config

option in your ``~/.gitconfig`` file.