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

Update copyright header #235

Merged
merged 11 commits into from
Jan 7, 2025
Merged

Update copyright header #235

merged 11 commits into from
Jan 7, 2025

Conversation

04kash
Copy link
Collaborator

@04kash 04kash commented Jan 3, 2025

Hey, I just made a Pull Request!

This PR updates the copyright header template to accept copyright headers with either "The RHDH Authors" or "The Backstage" (since a lot of the workflows used in this repository are from backstage/community-plugins) as valid options.

The header files for the following workspaces are also updated in the PR: bulk-import, global-header, homepage, lightspeed, marketplace, openshift-image-registry, theme.

I will update the orchestrator workplace files in a separate PR as it has few eslint errors.

Fixes: https://issues.redhat.com/browse/RHIDP-5401

✔️ Checklist

  • A changeset describing the change and affected packages. (more info)
  • Added or Updated documentation
  • Tests for new functionality and regression tests for bug fixes
  • Screenshots attached (for UI changes)

@rhdh-gh-app
Copy link

rhdh-gh-app bot commented Jan 3, 2025

Missing Changesets

The following package(s) are changed by this PR but do not have a changeset:

  • @red-hat-developer-hub/backstage-plugin-bulk-import-backend
  • @red-hat-developer-hub/backstage-plugin-bulk-import-common
  • @red-hat-developer-hub/backstage-plugin-bulk-import
  • @red-hat-developer-hub/backstage-plugin-dynamic-home-page
  • @red-hat-developer-hub/backstage-plugin-lightspeed-backend
  • @red-hat-developer-hub/backstage-plugin-lightspeed-common
  • @red-hat-developer-hub/backstage-plugin-lightspeed
  • @red-hat-developer-hub/backstage-plugin-openshift-image-registry
  • @red-hat-developer-hub/backstage-plugin-theme

See CONTRIBUTING.md for more information about how to add changesets.

Changed Packages

Package Name Package Path Changeset Bump Current Version
app workspaces/bulk-import/packages/app none v0.0.3
backend workspaces/bulk-import/packages/backend none v0.0.0
@red-hat-developer-hub/backstage-plugin-bulk-import-backend workspaces/bulk-import/plugins/bulk-import-backend none v5.2.1
@red-hat-developer-hub/backstage-plugin-bulk-import-common workspaces/bulk-import/plugins/bulk-import-common none v1.4.2
@red-hat-developer-hub/backstage-plugin-bulk-import workspaces/bulk-import/plugins/bulk-import none v1.10.7
@red-hat-developer-hub/backstage-plugin-global-header workspaces/global-header/plugins/global-header none v0.0.0
@red-hat-developer-hub/backstage-plugin-dynamic-home-page workspaces/homepage/plugins/dynamic-home-page none v1.0.3
@red-hat-developer-hub/backstage-plugin-lightspeed-backend workspaces/lightspeed/plugins/lightspeed-backend none v0.2.1
@red-hat-developer-hub/backstage-plugin-lightspeed-common workspaces/lightspeed/plugins/lightspeed-common none v0.1.2
@red-hat-developer-hub/backstage-plugin-lightspeed workspaces/lightspeed/plugins/lightspeed none v0.2.4
@red-hat-developer-hub/backstage-plugin-catalog-backend-module-marketplace workspaces/marketplace/plugins/catalog-backend-module-marketplace none v0.0.0
@red-hat-developer-hub/backstage-plugin-marketplace-backend workspaces/marketplace/plugins/marketplace-backend none v0.0.0
@red-hat-developer-hub/backstage-plugin-marketplace-common workspaces/marketplace/plugins/marketplace-common none v0.0.0
@red-hat-developer-hub/backstage-plugin-marketplace workspaces/marketplace/plugins/marketplace none v0.0.0
@red-hat-developer-hub/backstage-plugin-openshift-image-registry workspaces/openshift-image-registry/plugins/openshift-image-registry none v1.10.4
@red-hat-developer-hub/cli workspaces/repo-tools/packages/cli none v0.0.1
@red-hat-developer-hub/backstage-plugin-bc-test workspaces/theme/plugins/bc-test none v0.1.0
@red-hat-developer-hub/backstage-plugin-mui4-test workspaces/theme/plugins/mui4-test none v0.1.0
@red-hat-developer-hub/backstage-plugin-mui5-test workspaces/theme/plugins/mui5-test none v0.1.0
@red-hat-developer-hub/backstage-plugin-theme workspaces/theme/plugins/theme none v0.4.9

@@ -1,5 +1,5 @@
/*
* Copyright 2024 The Backstage Authors
* Copyright 2025 The RHDH Authors
Copy link
Member

@nickboldt nickboldt Jan 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this actually be a range of dates? eg., 2024-2025?

Copy link
Member

@christoph-jerolimov christoph-jerolimov Jan 3, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

And when its okay, just another "idea": is RHDH Authors really a thing or should we go one step forward and say something like "Copyright 2024 Red Hat and contributors"

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Changed it to Red Hat, Inc. based on the other copyright notices in the redhat-developer org

.eslintrc.cjs Outdated Show resolved Hide resolved
@christoph-jerolimov
Copy link
Member

Hey @04kash, I always wanted start a code-review with this words..

I'm not a lawyar 😄 but I think we should keep the first year we introduced the code, so 2024 in most cases here. It's nice that we update the author from backstage to RHDH for all code and the template to 2025.

@rm3l
Copy link
Member

rm3l commented Jan 4, 2025

Hey @04kash, I always wanted start a code-review with this words..

I'm not a lawyar 😄 but I think we should keep the first year we introduced the code, so 2024 in most cases here. It's nice that we update the author from backstage to RHDH for all code and the template to 2025.

There is an interesting article titled Copyright Notices for Open Source Projects from the Legal team on The Source. It does not make it mandatory to include the year.

 [...]
We do not recommend inclusion of the year in the copyright notice.
Attempting to consistently maintain dates in copyright notices is difficult, time-consuming, and is unnecessary.

So I think we can maybe simplify and omit the year.

@04kash
Copy link
Collaborator Author

04kash commented Jan 5, 2025

There is an interesting article titled Copyright Notices for Open Source Projects from the Legal team on The Source. It does not make it mandatory to include the year.
[...] We do not recommend inclusion of the year in the copyright notice. Attempting to consistently maintain dates in copyright notices is difficult, time-consuming, and is unnecessary.
So I think we can maybe simplify and omit the year.

Yup I agree omitting the date would make things easier!

@04kash 04kash force-pushed the update-copyright-header branch from 1ab533f to eb870b1 Compare January 6, 2025 13:04
Copy link
Member

@christoph-jerolimov christoph-jerolimov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Lgtm!

@christoph-jerolimov
Copy link
Member

We have currently 20 other PRs, but it looks like most of them are version updates and bugfixes that doesn't introduce new files. There is just one feature PR opened today that needs to be updated anyway.

I guess it's acceptable to merge this change right now and see how many PRs needs to be updated with this new (eslint) requirement.

@christoph-jerolimov christoph-jerolimov merged commit d054768 into main Jan 7, 2025
21 checks passed
@christoph-jerolimov christoph-jerolimov deleted the update-copyright-header branch January 7, 2025 09:03
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

Successfully merging this pull request may close these issues.

4 participants