This is an automated email from the ASF dual-hosted git repository. ethanfeng pushed a commit to branch update-release-doc in repository https://gitbox.apache.org/repos/asf/celeborn-website.git
commit a32bc8fb4c706e8faff0c43dcbad14776f8555d3 Author: mingji <[email protected]> AuthorDate: Wed Jun 12 16:02:00 2024 +0800 add license and notice description --- docs/community/release_guide.md | 37 +++++++++++++++++++++++++++++++++++++ 1 file changed, 37 insertions(+) diff --git a/docs/community/release_guide.md b/docs/community/release_guide.md index d5f09805d..bf23d60c5 100644 --- a/docs/community/release_guide.md +++ b/docs/community/release_guide.md @@ -175,6 +175,41 @@ 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: + +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 @@ -184,6 +219,8 @@ The tag pattern is `v${RELEASE_VERSION}-rc${RELEASE_RC_NO}`, e.g. `v0.5.0-rc0` !!! note After all the voting passed, be sure to create a final tag with the pattern: `v${RELEASE_VERSION}` +!!! note + Before a release candidates is published, check the license and notice in the binary package first. ```shell # Bump to the release version
