search

voxpupuli / vox-pupuli-tasks

Community tool to manage open PRs for puppet modules
https://voxpupu.li
GNU Affero General Public License v3.0
7 stars 9 forks source link

Parse README.md header? #6

Open bastelfreak opened 5 years ago

bastelfreak commented 5 years ago

We need multiple things in our README.md, for example a table of contents and a bunch of images. For example

[![Build Status](https://travis-ci.org/voxpupuli/puppet-zabbix.svg?branch=master)](https://travis-ci.org/voxpupuli/puppet-zabbix)
[![Code Coverage](https://coveralls.io/repos/github/voxpupuli/puppet-zabbix/badge.svg?branch=master)](https://coveralls.io/github/voxpupuli/puppet-zabbix)
[![Puppet Forge](https://img.shields.io/puppetforge/v/puppet/zabbix.svg)](https://forge.puppetlabs.com/puppet/zabbix)
[![Puppet Forge - downloads](https://img.shields.io/puppetforge/dt/puppet/zabbix.svg)](https://forge.puppetlabs.com/puppet/zabbix)
[![Puppet Forge - endorsement](https://img.shields.io/puppetforge/e/puppet/zabbix.svg)](https://forge.puppetlabs.com/puppet/zabbix)
[![Puppet Forge - scores](https://img.shields.io/puppetforge/f/puppet/zabbix.svg)](https://forge.puppetlabs.com/puppet/zabbix)
[![puppetmodule.info docs](http://www.puppetmodule.info/images/badge.png)](http://www.puppetmodule.info/m/AUTHOR-MODULE)
[![AGPL v3 License](https://img.shields.io/github/license/voxpupuli/puppet-lldpd.svg)](LICENSE)

There are multiple ways to verify that those are present, for example git hooks, a rake task that's triggered during the CI runs or a check within our application. That would also allow us to easily fix it.

bastelfreak commented 3 years ago

besides that, there should also be something like this: https://github.com/voxpupuli/modulesync_config/pull/665/files

Also please consider sending in your profile code that calls this component module as an acceptance test or provide it to us via an issue. This helps us a lot to test your use case and ensures we don't break the module!