You are viewing a plain text version of this content. The canonical link for it is here.
Posted to general@incubator.apache.org by Alex Porcelli <po...@apache.org> on 2024/11/01 20:53:12 UTC
How to proper document `binary` files as part of the source zip?
Hi IPMC members,
The Apache KIE podling requires several binary files (e.g., .jar and
.zip files) solely for testing purposes. These files are appropriately
stored within the designated test folder, and we want to ensure that
the need and usage of these files are documented clearly.
Additionally, there is an OpenOffice drawing that we use for
documentation purposes.
Could you please advise on the best location or approach to document
both these binary files and the OpenOffice drawing?
Thank you for your guidance.
Best regards,
Alex
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org
Re: How to proper document `binary` files as part of the source zip?
Posted by Alex Porcelli <al...@porcelli.me>.
Jason (cc'ed) just shared this [1] with me, this is exactly what I was
looking for.
[1] - https://github.com/apache/incubator-stormcrawler/blob/stormcrawler-3.1.0/DISCLAIMER-BINARIES.txt
On Fri, Nov 1, 2024 at 5:12 PM Alex Porcelli <al...@porcelli.me> wrote:
>
> Hi PJ,
>
> Maybe add information here[1] and here [2]? I was also wondering if
> wasn't worth adding to WIP-DISCLAIMER or NOTICE as well.
>
> [1] https://kie.apache.org/docs/community/verify
> [2] https://kie.apache.org/docs/community/build
>
> On Fri, Nov 1, 2024 at 5:08 PM PJ Fanning <fa...@apache.org> wrote:
> >
> > I would suggest using Confluence [1] or GitHub wiki or markdown files.
> > For me, I would like to see a document aimed at new contributors and
> > IPMC members about how to build KIE from source and that could then
> > also include details about the test binaries.
> >
> > [1] https://cwiki.apache.org/confluence
> >
> > On Fri, 1 Nov 2024 at 21:53, Alex Porcelli <po...@apache.org> wrote:
> > >
> > > Hi IPMC members,
> > >
> > > The Apache KIE podling requires several binary files (e.g., .jar and
> > > .zip files) solely for testing purposes. These files are appropriately
> > > stored within the designated test folder, and we want to ensure that
> > > the need and usage of these files are documented clearly.
> > > Additionally, there is an OpenOffice drawing that we use for
> > > documentation purposes.
> > >
> > > Could you please advise on the best location or approach to document
> > > both these binary files and the OpenOffice drawing?
> > >
> > > Thank you for your guidance.
> > >
> > > Best regards,
> > > Alex
> > >
> > > ---------------------------------------------------------------------
> > > To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
> > > For additional commands, e-mail: general-help@incubator.apache.org
> > >
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
> > For additional commands, e-mail: general-help@incubator.apache.org
> >
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org
Re: How to proper document `binary` files as part of the source zip?
Posted by Alex Porcelli <al...@porcelli.me>.
Hi PJ,
Maybe add information here[1] and here [2]? I was also wondering if
wasn't worth adding to WIP-DISCLAIMER or NOTICE as well.
[1] https://kie.apache.org/docs/community/verify
[2] https://kie.apache.org/docs/community/build
On Fri, Nov 1, 2024 at 5:08 PM PJ Fanning <fa...@apache.org> wrote:
>
> I would suggest using Confluence [1] or GitHub wiki or markdown files.
> For me, I would like to see a document aimed at new contributors and
> IPMC members about how to build KIE from source and that could then
> also include details about the test binaries.
>
> [1] https://cwiki.apache.org/confluence
>
> On Fri, 1 Nov 2024 at 21:53, Alex Porcelli <po...@apache.org> wrote:
> >
> > Hi IPMC members,
> >
> > The Apache KIE podling requires several binary files (e.g., .jar and
> > .zip files) solely for testing purposes. These files are appropriately
> > stored within the designated test folder, and we want to ensure that
> > the need and usage of these files are documented clearly.
> > Additionally, there is an OpenOffice drawing that we use for
> > documentation purposes.
> >
> > Could you please advise on the best location or approach to document
> > both these binary files and the OpenOffice drawing?
> >
> > Thank you for your guidance.
> >
> > Best regards,
> > Alex
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
> > For additional commands, e-mail: general-help@incubator.apache.org
> >
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
> For additional commands, e-mail: general-help@incubator.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org
Re: How to proper document `binary` files as part of the source zip?
Posted by PJ Fanning <fa...@apache.org>.
I would suggest using Confluence [1] or GitHub wiki or markdown files.
For me, I would like to see a document aimed at new contributors and
IPMC members about how to build KIE from source and that could then
also include details about the test binaries.
[1] https://cwiki.apache.org/confluence
On Fri, 1 Nov 2024 at 21:53, Alex Porcelli <po...@apache.org> wrote:
>
> Hi IPMC members,
>
> The Apache KIE podling requires several binary files (e.g., .jar and
> .zip files) solely for testing purposes. These files are appropriately
> stored within the designated test folder, and we want to ensure that
> the need and usage of these files are documented clearly.
> Additionally, there is an OpenOffice drawing that we use for
> documentation purposes.
>
> Could you please advise on the best location or approach to document
> both these binary files and the OpenOffice drawing?
>
> Thank you for your guidance.
>
> Best regards,
> Alex
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
> For additional commands, e-mail: general-help@incubator.apache.org
>
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org
Re: How to proper document `binary` files as part of the source zip?
Posted by Justin Mclean <ju...@classsoftware.com>.
Hi,
It is different as (from the last release) it contains teh following jars:
./incubator-kie-kogito-runtimes/quarkus/integration-tests/integration-tests-quarkus-gradle/integration-tests-quarkus-gradle-project/gradle/wrapper/gradle-wrapper.jar
./incubator-kie-kogito-runtimes/.mvn/wrapper/maven-wrapper.jar
./incubator-kie-kogito-runtimes/kogito-codegen-modules/kogito-codegen-core/src/test/resources/empty.jar
./incubator-kie-tools/packages/stunner-editors/errai-ui/src/test/resources/less.jar
./incubator-kie-kogito-apps/.mvn/wrapper/maven-wrapper.jar
./incubator-kie-drools/efesto/efesto-core/efesto-common-api/src/test/resources/TestJar.jar
./incubator-kie-drools/efesto/efesto-core/efesto-runtime-manager/efesto-runtime-manager-core/src/test/resources/TestJar.jar
./incubator-kie-drools/efesto/efesto-core/efesto-common-core/src/test/resources/TestJar.jar
./incubator-kie-drools/drools-compiler/src/test/resources/primespoc.jar
./incubator-kie-drools/drools-compiler/src/test/resources/eventing-example.jar
./incubator-kie-drools/drools-compiler/src/test/resources/KAModelTest.jar
./incubator-kie-drools/drools-compiler/src/test/resources/JarWithSourceFiles.jar
./incubator-kie-drools/drools-test-coverage/test-compiler-integration/src/test/resources/only-jar-pojo-not-kjar-no-kmodule-1.0.0.jar
./incubator-kie-drools/drools-test-coverage/test-compiler-integration/src/test/resources/org/drools/mvel/compiler/compiler/xml/changeset/changeset.jar
./incubator-kie-drools/drools-test-coverage/test-compiler-integration/src/test/resources/billasurf.jar
./incubator-kie-drools/drools-test-coverage/test-compiler-integration/src/test/resources/kie-project-simple-1.0.0.jar
./incubator-kie-drools/drools-test-coverage/test-compiler-integration/src/test/resources/testEnum.jar
./incubator-kie-drools/drools-verifier/drools-verifier-drl/src/test/resources/org/drools/verifier/model.jar
./incubator-kie-drools/kie-ci/src/test/resources/kjar/kjar-module-before.jar
./incubator-kie-drools/kie-ci/src/test/resources/kjar/kjar-module-after.jar
./incubator-kie-drools/drools-legacy-test-util/src/test/resources/billasurf.jar
The gradle-wrapper.jar and maven-wrapper.jar are not allowed in a source release. The empty.jar jars are permitted as they don't contain compiled code. I’ve not looked at all the jars, but jars like JarWithSourceFiles.jar contains compiled code and would also not be allowed in a source release.
Kind Regards,
Justin
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org
Re: How to proper document `binary` files as part of the source zip?
Posted by Alex Porcelli <po...@apache.org>.
Justin,
Apache KIE podling needs are no different from StormCrawler [1].
[1] -
https://github.com/apache/incubator-stormcrawler/blob/stormcrawler-3.1.0/DISCLAIMER-BINARIES.txt
Regards,
_____________
Alex Porcelli
http://porcelli.me
On Fri, Nov 1, 2024 at 6:01 PM Justin Mclean <ju...@classsoftware.com>
wrote:
> HI,
>
> > The Apache KIE podling requires several binary files (e.g., .jar and
> > .zip files) solely for testing purposes.
>
> Compiled code is not allowed in a source release. If it is required for
> tests, then compiling the source for that test is generally an option.
>
> Kind Regards,
> Justin
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
> For additional commands, e-mail: general-help@incubator.apache.org
>
>
Re: How to proper document `binary` files as part of the source zip?
Posted by Justin Mclean <ju...@classsoftware.com>.
HI,
> The Apache KIE podling requires several binary files (e.g., .jar and
> .zip files) solely for testing purposes.
Compiled code is not allowed in a source release. If it is required for tests, then compiling the source for that test is generally an option.
Kind Regards,
Justin
---------------------------------------------------------------------
To unsubscribe, e-mail: general-unsubscribe@incubator.apache.org
For additional commands, e-mail: general-help@incubator.apache.org