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 description about how to update license and notice #67

Open
wants to merge 4 commits into
base: main
Choose a base branch
from
Open
Changes from 3 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 39 additions & 0 deletions docs/community/release_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -175,6 +175,45 @@ After cutting release branch, don't forget bump version in `main` branch.
export RELEASE_RC_NO=<RC number, e.g. 0>
```

- Check License and Notice

Build a release package and check license and notice with the binary package's jars directory instead of the pom.xml.
```shell
./buile/make-distribution.sh --release --sbt-enabled
```
According to the Apache License section 4, the principal of License and Notice is as following:
Copy link
Member

Choose a reason for hiding this comment

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

can we add the hyperlink for "Apache License section 4", and use quote syntax for the reference sections

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Added the hyperlink.
The following text is not a reference, it's a conclusion.
Ping @pan3793


LICENSE File
Basic Principle: The LICENSE file should contain the full text of the license for your
project (typically the Apache License 2.0) and should also acknowledge any third-party components
that are not wholly composed of the project code with corresponding license declarations.

Third-party Dependencies: If your Apache project utilizes third-party libraries or code under
different licenses, these dependencies should be enumerated in the LICENSE file with their
respective licensing information articulated. Ideally, this section should be sufficiently
detailed to inform users of the licensing terms of third-party components used.

Specific Attribution: For each dependency, it’s beneficial to include specific details such as
the library's name, version number, and its license. If the dependency’s license requires its
full text to be included with distributions, then that license text usually should be included
in your project (sometimes in the LICENSE file itself, other times as a separate file).

NOTICE File
Basic Principle: The NOTICE file is intended for including essential notices to users regarding
the Apache project and any third-party dependencies it may contain.

Attribution Statements: If third-party components require attributions to be presented in any
product that includes them broadly (such as recognized copyright statements or acknowledgement of use),
such attributions must be included in the NOTICE file. This is more than just listing
dependencies — it has to comply with the attribution and notice requirements of the third-party licenses.

Conciseness and Clarity: The NOTICE file should be brief, containing only necessary attributions
and legal acknowledgements. It is not required to provide attributions for every third-party
library used in the project, but only for those that specifically require mention in the NOTICE file.

Avoid Over-Inclusion: Be careful not to include superfluous or inapplicable statements in the NOTICE file.
ASF emphasizes that the file should be kept as concise as possible.

- Bump version.

Considering that other committers may merge PRs during your release period, you should accomplish the version change
Expand Down