grimoirelab-perceval-puppet's Introduction

perceval-puppet

Bundle of Perceval backends for Puppet ecosystem.

Backends

The backends currently managed by this package support the next repositories:

Puppet Forge

Requirements

Python >= 3.8

You will also need some other libraries for running the tool, you can find the whole list of dependencies in pyproject.toml file.

Installation

There are several ways to install perceval-puppet on your system: packages or source code using Poetry or pip.

PyPI

perceval-puppet can be installed using pip, a tool for installing Python packages. To do it, run the next command:

$ pip install perceval-puppet

Source code

To install from the source code you will need to clone the repository first:

$ git clone https://github.com/chaoss/grimoirelab-perceval-puppet
$ cd grimoirelab-perceval-puppet

Then use pip or Poetry to install the package along with its dependencies.

Pip

To install the package from local directory run the following command:

$ pip install .

In case you are a developer, you should install perceval-puppet in editable mode:

$ pip install -e .

Poetry

We use poetry for dependency management and packaging. You can install it following its documentation. Once you have installed it, you can install perceval-puppet and the dependencies in a project isolated environment using:

$ poetry install

To spaw a new shell within the virtual environment use:

$ poetry shell

Examples

Puppet Forge

$ perceval puppetforge

License

Licensed under GNU General Public License (GPL), version 3 or later.

grimoirelab-perceval-puppet's Issues

Update perceval required version

The current minimum version of Perceval to run these backends is wrong. Please update it.

Build packages for this module

This module already has configuration for building a package, but we should produce packages.

Require DCO sign-off for new commits

This issue is to activate protobot/dco (or similar bot) to check that all commits have a sign-off in this repository.

The CHAOSS Project Charter section 8.2.1 requires that all contributions are signed-off. The CHAOSS project has been piloting the use of DCO sign-offs. Once contributors know how to do it, sign-offs are easy to do with little overhead.

For users of the git command line interface, a sign-off is accomplished with the -s as part of the commit command: git commit -s -m 'This is a commit message'

For users of the GitHub interface, a sign-off is accomplished by writing Signed-off-by: Your Name <[email protected]> into the commit comment field. This can be automated by using a browser plugin like scottrigby/dco-gh-ui

To-Do for repo maintainers: Please inform your contributors about DCO sign-offs and comment on this issue when your are ready for the DCO bot to be activated on this repository.

Recommend Projects