conventionalcomments-web-ext

Browser extension which brings conventionalcomments into GitLab.

Installation

Firefox: https://addons.mozilla.org/de/firefox/addon/conventional-comments/
Chrome: https://chrome.google.com/webstore/detail/conventional-comments/pagggmojbbphjnpcjeeniigdkglamffk

How to contribute

Run the development build

1. Install dependencies by running yarn
2. Run yarn dev (it will open Firefox with the extension installed)

Run the tests

For GitLab

1. Create a new GitLab user (it's recommmended using a user without personal information)
2. Copy config/template_local.js to config/local.js and replace all values
3. Run yarn test to run unit tests
4. Run yarn codeceptjs to run end-to-end tests

For GitHub

1. Create a new GitHub user (it's recommmended using a user without personal information)
2. Copy config/template_local.js to config/local.js and replace all values
3. Activate the 2FA authentication
   1. Copy the two-factor secret in codeceptjs.github.twoFactorSecret
   2. Run yarn github-2fa-code an paste the code printed into the field in GitHub
   3. Finalize the 2FA
4. Run yarn test to run unit tests
5. Run yarn codeceptjs to run end-to-end tests

Generate the screenshots

Some screenshots might not have exactly the same size locally compared to the CI. The following commands will ensure the screenshots are taken the same way than on the CI.

1. Run docker-compose build update-screenshots
2. Run docker-compose run update-screenshots

Another way is to take them directly from the last CI e2e-tests. To do so, run node scripts/updateScreenshotFromCI.js.

Build the extension

1. Run yarn build
2. Check folder web-ext-artifacts