Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: Commit Linter needs to allow multiple packages listed in scope #581

Closed
1 task
virkt25 opened this issue Sep 20, 2017 · 4 comments
Closed
1 task

ci: Commit Linter needs to allow multiple packages listed in scope #581

virkt25 opened this issue Sep 20, 2017 · 4 comments
Labels
developer-experience Issues affecting ease of use and overall experience of LB users

Comments

@virkt25
Copy link
Contributor

virkt25 commented Sep 20, 2017

Overview

A key benefit of lerna is the ability of being able to change multiple packages if needed in one PR to make fixes and feature implementation easier.

Conventional Commit message guidelines require the header format to be <type>(<scope>): <description> where scope is the affected package name. Travis CI enforces this convention using commitlint.

Depending on the outcome of https://github.com/marionebl/commitlint/issues/75 we need to create the new scope-types rule (if / when) there is a plugin API available for commitlint
OR
We need to implement our own solution that can leverage conventional-commits-parser with a custom headerPattern (adding , to the default pattern). Then split it and check against available packages (check commitlint's lerna config for getting scope-enum automatically).

Acceptance Criteria

  • One of the above two solutions (or another) implemented that allows me to make a commit with no scope, 1 package in scope, 2 or more packages in scope. All packages in scope must be valid.
@marionebl
Copy link

Relevant issue with conventional-commits-parser: conventional-changelog/conventional-changelog#232

@bajtos bajtos added the non-MVP label Nov 2, 2017
@bajtos bajtos added the developer-experience Issues affecting ease of use and overall experience of LB users label Dec 15, 2017
@stale
Copy link

stale bot commented Jun 13, 2018

This issue has been marked stale because it has not seen activity within six months. If you believe this to be in error, please contact one of the code owners, listed in the CODEOWNERS file at the top-level of this repository. This issue will be closed within 30 days of being stale.

@stale stale bot added the stale label Jun 13, 2018
@jannyHou jannyHou removed the stale label Jun 13, 2018
@bajtos
Copy link
Member

bajtos commented Jun 25, 2018

IMO, this is a "nice to have" feature. Commits modifying multiple packages are omitting the scope now and I don't remember any issues caused by the missing scope.

I am proposing to close this issue and focus on more important tasks.

@virkt25 thoughts?

@bajtos bajtos added post-GA and removed Core-GA labels Jun 25, 2018
@virkt25
Copy link
Contributor Author

virkt25 commented Jun 25, 2018

I agree, plus this change is something we would pick up from conventional-commits if it's implemented there. Closing for now.

@virkt25 virkt25 closed this as completed Jun 25, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
developer-experience Issues affecting ease of use and overall experience of LB users
Projects
None yet
Development

No branches or pull requests

4 participants