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

Add SPDX headers & enforcement to all egeria* repositories #6992

Closed
1 of 2 tasks
planetf1 opened this issue Oct 10, 2022 · 2 comments
Closed
1 of 2 tasks

Add SPDX headers & enforcement to all egeria* repositories #6992

planetf1 opened this issue Oct 10, 2022 · 2 comments
Assignees
Labels
build-improvement Build improvements - maven, gradle, GitHub actions cross-project Apply to many repositories in odpi/* enhancement New feature or request gradle Gradle build (new initiative) licensing Issues with file licensing & copyright
Milestone

Comments

@planetf1
Copy link
Member

Is there an existing issue for this?

  • I have searched the existing issues

Please describe the new behavior that that will improve Egeria

Egeria currently enforces SPDX headers similar to:

# SPDX-License-Identifier: Apache-2.0
# Copyright Contributors to the ODPi Egeria project.

where the comments are file type dependent.

However this has not been applied across all repositories - typically files were initially created with these headers, but as there is no build-time enforcement, the headers can get dropped, or missed from new files.

In addition the current enforcement in the main egeria repository relies on maven, but we are moving to gradle.

This issue is opened to track verifying and enforcing across all repos, through a combination of

  • guidance in our documentation
  • seeing if we can create common build scripts to more easily maintain
  • adding in each repo

Alternatives

No response

Any Further Information?

No response

Would you be prepared to be assigned this issue to work on?

  • I can work on this
@planetf1 planetf1 added enhancement New feature or request licensing Issues with file licensing & copyright labels Oct 10, 2022
@planetf1 planetf1 added the build-improvement Build improvements - maven, gradle, GitHub actions label Oct 19, 2022
@planetf1 planetf1 self-assigned this Nov 16, 2022
@planetf1 planetf1 added gradle Gradle build (new initiative) cross-project Apply to many repositories in odpi/* labels Dec 5, 2022
@planetf1 planetf1 added this to the 4.0 milestone Dec 5, 2022
@github-actions
Copy link

github-actions bot commented Feb 4, 2023

This issue has been automatically marked as stale because it has not had recent activity. It will be closed in 20 days if no further activity occurs. Thank you for your contributions.

@github-actions github-actions bot added the no-issue-activity Issues automatically marked as stale because they have not had recent activity. label Feb 4, 2023
@planetf1 planetf1 removed the no-issue-activity Issues automatically marked as stale because they have not had recent activity. label Feb 6, 2023
@planetf1 planetf1 mentioned this issue Feb 6, 2023
25 tasks
planetf1 added a commit to planetf1/egeria that referenced this issue Feb 6, 2023
Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
@planetf1
Copy link
Member Author

planetf1 commented Mar 7, 2023

Another alternative proposed was spotless

This offers a lot of code formatting flexibility - however for now we purely want to check license headers
It does more easily allow for scans of non-java code

In experimenting, I was not able to

  • handle varying whitespace (between comments and texts)
  • invoke both license & copyright check

I raised diffplug/spotless#1611 to pose the question - if it is possible with spotless, we can refactor to use that more modern/flexible plugin instead.

planetf1 added a commit that referenced this issue Mar 7, 2023
#6992 Add SPDX checking for copyright/license (java)
planetf1 added a commit to planetf1/egeria that referenced this issue Mar 7, 2023
Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
planetf1 added a commit to planetf1/egeria that referenced this issue Mar 7, 2023
Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
planetf1 added a commit to planetf1/egeria that referenced this issue Mar 7, 2023
Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
planetf1 added a commit to planetf1/egeria that referenced this issue Mar 7, 2023
Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
planetf1 added a commit to planetf1/egeria that referenced this issue Mar 7, 2023
Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
planetf1 added a commit to planetf1/egeria that referenced this issue Mar 7, 2023
…f detected

Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
planetf1 added a commit to planetf1/egeria that referenced this issue Mar 7, 2023
Signed-off-by: Nigel Jones <nigel.l.jones+git@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build-improvement Build improvements - maven, gradle, GitHub actions cross-project Apply to many repositories in odpi/* enhancement New feature or request gradle Gradle build (new initiative) licensing Issues with file licensing & copyright
Projects
None yet
Development

No branches or pull requests

1 participant