bitflicker64 commented on code in PR #511:
URL: https://github.com/apache/hugegraph-doc/pull/511#discussion_r4238781300
##########
content/en/docs/contribution-guidelines/contribute.md:
##########
@@ -74,9 +81,22 @@ GitHub requires a username and token for Git authentication
instead of a usernam
When adding a third-party dependency, also update the license information
included in the distribution:
-1. Add the dependency's license file to
`hugegraph-server/hugegraph-dist/release-docs/licenses/`.
-2. Update `hugegraph-server/hugegraph-dist/release-docs/LICENSE`. If the
dependency includes a NOTICE file, update `NOTICE` as well.
-3. Run
`hugegraph-server/hugegraph-dist/scripts/dependency/regenerate_known_dependencies.sh`
to update the known-dependency list.
+1. Add the dependency's license file to `install-dist/release-docs/licenses/`.
+2. Update `install-dist/release-docs/LICENSE`. If the dependency includes a
NOTICE file, update `NOTICE` as well.
+3. From the repository root, prepare the current revision's Server, PD and
Store distribution libraries before regenerating the inventory:
+
+ ```bash
+ mvn clean install -DskipTests -Dmaven.javadoc.skip=true
+ bash install-dist/scripts/dependency/regenerate_known_dependencies.sh
+ ```
+
+ Clean rebuilds the current revision's distributions to avoid stale
dependency jars.
+ It also removes root-level `*.tar.gz` distribution archives; other revision
directories remain.
Review Comment:
Minor: This sentence puts the `*.tar.gz` cleanup in the wrong directory. On
apache/hugegraph master `36bc1c64b` the root `pom.xml` has no Clean fileset.
The `*.tar` / `*.tar.gz` includes belong to `hugegraph-server/pom.xml`,
`hugegraph-pd/pom.xml` and `hugegraph-store/pom.xml`, each with
`<directory>${project.basedir}/</directory>`, so they apply to those three
module directories. At the repository root only `install-dist/pom.xml` cleans,
and it names `${final.name}.tar.gz` and `${final.name}/`, which is the current
revision alone. I checked this with `mvn -o clean` from the root of a throwaway
master worktree seeded with marker files: in the repository root
`apache-hugegraph-1.8.0.tar.gz` and `apache-hugegraph-1.8.0/` were removed
while `other.tar.gz` and `apache-hugegraph-1.7.0.tar.gz` stayed; in
`hugegraph-server/`, `hugegraph-pd/` and `hugegraph-store/` every `*.tar.gz`
was removed, `other.tar.gz` included, and the `apache-hugegraph-<kind>-1.7.0/`
directories stayed. So a cont
ributor who keeps an older release tarball inside one of the module
directories loses it, and the sentence tells them to look at the repository
root instead. Please name the directories, for example: "It also removes every
`*.tar` and `*.tar.gz` file directly under `hugegraph-server/`, `hugegraph-pd/`
and `hugegraph-store/`, plus the current revision's
`apache-hugegraph-<revision>.tar.gz` in the repository root; directories of
other revisions remain." The Chinese page says the repository root outright on
line 93 of `content/cn/docs/contribution-guidelines/contribute.md` and needs
the same change.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
