zenika-open-source/hygie

Easy-to-use NestJS API allowing you to interact with GIT events and manage your project's life-cycle.

hygie's Issues

Add TDD for Rule and Runnable

New Post Action to Deploy to Firebase Hosting on a PR/MR

If the application if a Firebase app, we can deploy everything thanks to firebase-tools CLI
If the application is a Web app, we can deploy on Firebase Hostings

Mettre en place un système de logging

Au lieu d'utiliser des console.log , nous pourrions utiliser une librairie de logging. Comme Winston

Add workflow in our rules config file ?

Post Actions - Deploy on Github / Gitlab pages

• Github
• Gitlab ==> Waiting for API updates

When a branch is created , automatically create a WIP PR / MR

Maybe we can extract something from the branch name .
If the newly created branch is feature/blablabla we can maybe create a PR/MR named WIP: blablabla

Setup Script NPM pour CI

Manage HTTP status code

return for exemple 403 when we recieved an unacceptable request

Documention about to deploy Hygie

• on Openfaas

Créer une image Docker pour l'application

New rule : One commit per PR/MR

Add default values for Rule and Runnable

Ajouter Husky

Allow templating in rule.yml

Install Github / Gitlab locally

Setup TDD

Add a Webhook post-action

Add in a doc a regular expression to check a commit message contain the issue ID

Add npm audit in Circle CI

Init pipelines for executing rules

If we want to add more rules (yes we do), we must thing about the pipeline that will execute them.

In order to test this behavior, lets first create a second rule. When a new branch is created, we should check its name via an regular expression also. You can use this regexp: (features|fix)\/.* . This rule should be configurable via the yml configuration file.

We have now two rules. How can we execute them synchronously ? If on rule failed, we should not execute the following ones.

We can maybe use dependency injection in NestJS ?

Create a CLI for executing our rules

In order to make our rules useable on the developer device, we can maybe create a command line interface ?

Documentation : Add arguments why our solution is the best :p

• Run with Gitlab and Github
• Avoid the creation of scripts

Extend RuleResult property

It could be interesting to provide more data usable in callbacks.
For example, always return gitApiInfos

Add Post-Actions, Rule, and others labels to changelog

Add Coveralls

Make dependency injection working

• For Rules
• For Runnable

Add a script for creating releases

We will add a script to Circle in order to create a release of our project. This script will be executed when a PR is accepted.
Here are the actions we should execute :

• Create a GIT tag
• Update the version in the package.json file
• Push the new image on the Docker hub
• Publish the CLI on the npm registry
• Publish the documentation on gh-pages
• Publish definition files on NPM registry
• Create a release notes

How to avoid issues we had for the 0.1.0 milestone ?

Do we have a Tslint rule that checks if we do an import with a *.ts extension ?

Develop the first rule

AS a first rule, we will check if the commit message match a specific regular expression. For example (feat|fix|docs)\(?[a-z]*\)?:\s.*

We will make this regexp configurable later.

Create a documentation website

We can maybe use VuePress. https://vuepress.vuejs.org/guide/#how-it-works

What do you think >

Is it possible to call a webhook when a project is created ?

Create a Nest CLI schematics in order add rules / runnable

Create an Runnable interface for post-actions

If we want to execute post action for a rule, we have to configure them in the rules.yml file. We also need a switch statement in order to get the actions we want to execute.

Maybe we can improve this pattern, by using multi values for providers in NestJS.

We can create a Runnable interface, with a name property and a run method. Based of this interface, we can also create many implementation. We will first focus on a Logger implementation.

When those actions have to be executed, we will inject the right providers (an array) on which we will do a filter in order to get only the actions configured in the rules.yml file.

Add a Post Action to add a comment on a MR/PR

Create a release notes when detecting a new tag

When a new tag is detected, we should create a release notes (based on the accepted or closed issue ?) and update the release panel of Gitlab / Github

Add Bitbucket

Setup CI on CircleCI

Add runnable in order send email

Gitlab Docker persistent data

Create NestJS interceptor in order to convert Gitlab/Github objects

Github and Gitlab objects are (I think) not the same. In order to make our rules easier to read and maintain we should create our own models.
In order to convert Gitlab/Github objects to our models, we can create a NEST.js interceptor ?
As a first step, we will create only the model used by the rule #7

Setup NestJS

Typescript definition files for Github and Gitlab API

Do we have definition files for Gitlab and Github API ?
If not, we will create them and publish them on the NPM registry.

If this files do not existe, we will create them, and improve them based on the use of the APIs

commitMessage should check all commits of a PR

During a Pull Request/Merge Request, we should check if all commits respect the regular expression

Add checks at bootstrap

We must create checks when the server is started, in order to be sure everything is OK.
The first check we can implement will check if the config file is present and valid.

Add Rule to check the name of an issue

and this label match a regexp, add a comment to the issue in order to ping a specific team of the orga.

Add the possibility to add a configuration file per project

Make a rule configurable via a .yml config file

We will start first with the only rule we have. The one developed here #7

Add a Post Action to add a comment on a Issue

Interaction with Github Actions

Add rule to check the name of a PR/MR

and if this label match a regexp, add a comment to the issue in order to ping a specific team of the orga.