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

Ensure that license header in source files is always present #1232

Closed
nikku opened this issue Feb 14, 2019 · 1 comment
Closed

Ensure that license header in source files is always present #1232

nikku opened this issue Feb 14, 2019 · 1 comment
Milestone

Comments

@nikku
Copy link
Member

nikku commented Feb 14, 2019

As a follow up to #1231 we should establish a mechanism that ensures that the license header is always present (also in new files) and stays up to date. We should come up with something we can roll out across our entire project sphere (~90 bpmn.io projects), this project and friends.

Approaches

Incomplete list of directions to take:

  • Git hook (needs to be installed by all contributors to work)
  • GitHub Check + Github Bot (how could a bot help / support us)?

Bot Tasks

Possible tasks a bot can help us to deal with:

  • Reject new files without license headers
  • Automatically add license headers (for internal PRs)
  • File PRs to renew license year
@nikku nikku added this to the M29 milestone Feb 14, 2019
nikku added a commit that referenced this issue Feb 20, 2019
@nikku nikku added the needs review Review pending label Feb 20, 2019
@nikku
Copy link
Member Author

nikku commented Feb 20, 2019

Solution we went for:

  • enforce license headers via eslint rule (camunda-licensed/mit)
  • not adding a license will fail CI
  • npm run lint -- --fix will add the appropriate licenses

@ghost ghost removed the needs review Review pending label Feb 21, 2019
@nikku nikku modified the milestones: M29, M28 Mar 6, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant