https://github.com/boubkerbribri/prestashopissuesreport

Simple PHP tool to gather issues data from GitHub aPI for the PrestaShop project
https://github.com/boubkerbribri/prestashopissuesreport

api github php prestashop

Last synced: about 1 month ago
JSON representation

Simple PHP tool to gather issues data from GitHub aPI for the PrestaShop project

• Host: GitHub
• URL: https://github.com/boubkerbribri/prestashopissuesreport
• Owner: boubkerbribri
• Created: 2020-05-12T09:10:47.000Z (almost 5 years ago)
• Default Branch: master
• Last Pushed: 2023-04-19T19:36:29.000Z (almost 2 years ago)
• Last Synced: 2024-11-14T23:32:17.097Z (3 months ago)
• Topics: api, github, php, prestashop
• Language: PHP
• Homepage:
• Size: 37.1 KB
• Stars: 1
• Watchers: 0
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Issues report tool

This tool is used to track all issues created in the last month (4 weeks) for the 

[PrestaShop](https://github.com/PrestaShop/PrestaShop) project. It will gather all its data from the GitHub v3 API.

## How it works

You give the script a `START_DATE` and an `END_DATE` through environment variables.

It will gather all issues created on this timeframe and :

- count the open and closed issues

- count regressions (including those found by automated tests)

- count duplicates

- create a table showing all duplicates and their original issue (along with the original issue status and priority)

## How to use

Create a file named `token.txt` at the root of the project and put your GitHub token in it.

You can use these environment variables:

- `START_DATE` : specify the start date of the timeframe (**mandatory**).

- `END_DATE`   : specify the end date of the timeframe. If not specified, will be calculated by adding 4 weeks 

to `START_DATE`. 

Launch the script by using this command :

```php

START_DATE=2020-05-01 END_DATE=2020-05-29 php generate.php

```

The final report is created in the `/reports/` folder. It uses the `template.md` file (you can modify it). 

Here are the main variables:

| Variable | Description |

| -------- | ----------- |

| %start-date% | Start date of the timeframe. Format `YYYY-M-DD` |

| %end-date% | End date of the timeframe. Format `YYYY-M-DD` |

| %issues-created% | Number of issues created on the period |

| %issues-open% | Number of open issues |

| %issues-closed% | Number of closed issues |

| %issues-duplicates% | Number of duplicates |

| %issues-duplicates-percentage% | Number of duplicates as a percentage (from all issues) |

| %issues-regressions% | Number of regressions |

| %issues-regressions-percentage% | Number of regressions as a percentage (from all issues) |

| %issues-detected-by-te% | Number of issues detected by automated tests |

| %issues-detected-by-te-percentage% | Number of issues detected by automated tests as a percentage (from all issues) |

| %duplicate-table% | Table of duplicate (fields: #, title, creation date, targeting BO or FO, Original issue, Origin status, Origin priority) |

|%creation-date% | Report creation datetime |