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

[532] Add DISCLAIMER file to META-INF folder in jars #539

Merged
merged 2 commits into from
Sep 18, 2024

Conversation

rangareddy
Copy link
Contributor

@rangareddy rangareddy commented Sep 17, 2024

Important Read

This pull request aims to address issues #532

What is the purpose of the pull request

Adding the DISCLAIMER file to META-INF folders in all jars.

Brief change log

  • Added the two new properties to tag in pom.xml
<apache-jar-resource-bundle.version>1.7</apache-jar-resource-bundle.version>
<apache-incubator-disclaimer-resource-bundle.version>1.7</apache-incubator-disclaimer-resource-bundle.version>
  • Added the <resourceBundles> to the maven-remote-resources-plugin plugin in pom.xml file.
<resourceBundles>
    <resourceBundle>org.apache.apache.resources:apache-jar-resource-bundle:${apache-jar-resource-bundle.version}</resourceBundle>
    <resourceBundle>org.apache.apache.resources:apache-incubator-disclaimer-resource-bundle:${apache-incubator-disclaimer-resource-bundle.version}</resourceBundle>
</resourceBundles>

Verify this pull request

Run $ mvn clean install -DskipTests -U locally and extract the jars and verify META-INF folder.

META-INF folder before this PR:

% ls -ltr META-INF 
total 48
drwxr-xr-x  3 rangareddy  staff     96 Jul  4 18:52 maven
-rw-r--r--  1 rangareddy  staff    176 Jul  4 18:52 NOTICE
-rw-r--r--  1 rangareddy  staff    341 Jul  4 18:52 MANIFEST.MF
-rw-r--r--  1 rangareddy  staff  11358 Jul  4 18:52 LICENSE
-rw-r--r--  1 rangareddy  staff   1942 Jul  4 18:52 DEPENDENCIES

META-INF folder after this PR:

% ls -ltr META-INF
total 56
drwxr-xr-x  3 rangareddy  staff     96 Jul  4 18:52 maven
-rw-r--r--  1 rangareddy  staff    179 Jul  4 18:52 NOTICE
-rw-r--r--  1 rangareddy  staff    341 Jul  4 18:52 MANIFEST.MF
-rw-r--r--  1 rangareddy  staff  11358 Jul  4 18:52 LICENSE
-rw-r--r--  1 rangareddy  staff    559 Jul  4 18:52 DISCLAIMER
-rw-r--r--  1 rangareddy  staff   1942 Jul  4 18:52 DEPENDENCIES

pom.xml Outdated Show resolved Hide resolved
DISCLAIMER Outdated Show resolved Hide resolved
@rangareddy
Copy link
Contributor Author

Hi @vinishjail97 Review the latest commit changes.

@vinishjail97
Copy link
Contributor

cat META-INF/DISCLAIMER

Apache XTable (incubating) is an effort undergoing incubation at the Apache Software 
Foundation (ASF), sponsored by the Apache Incubator PMC. 

Incubation is required of all newly accepted projects until a further review 
indicates that the infrastructure, communications, and decision making process 
have stabilized in a manner consistent with other successful ASF projects. 

While incubation status is not necessarily a reflection of the completeness 
or stability of the code, it does indicate that the project has yet to be 
fully endorsed by the ASF.

@pjfanning Can you confirm if this looks okay ? We are still keeping DISCLAIMER-WIP in the project though.

@vinishjail97
Copy link
Contributor

@rangareddy We can merge after @pjfanning gives an approval as well.

@pjfanning
Copy link
Contributor

pjfanning commented Sep 18, 2024

I think you should add DISCLAIMER-WIP to the jar instead of DISCLAIMER while the project uses the DISCLAIMER-WIP and change to DISCLAIMER when the project switches to DISCLAIMER. The exact same file that you have in the project - not some other file.

@vinishjail97
Copy link
Contributor

vinishjail97 commented Sep 18, 2024

I think you should add DISCLAIMER-WIP to the jar instead of DISCLAIMER while the project uses the DISCLAIMER-WIP and change to DISCLAIMER when the project switches to DISCLAIMER. The exact same file that you have in the project - not some other file.

@pjfanning I had the same doubt but the resource bundle provided by Apache for incubating projects doesn't have that ability.
https://maven.apache.org/apache-resource-bundles/incubator-disclaimer/
https://github.com/apache/maven-apache-resources/blob/master/incubator-disclaimer/src/main/resources/META-INF/DISCLAIMER.vm

Copy link
Contributor

@pjfanning pjfanning left a comment

Choose a reason for hiding this comment

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

Approving. Having the basic DISCLAIMER is better than having none.

@vinishjail97 vinishjail97 merged commit 5887678 into apache:main Sep 18, 2024
2 checks passed
@vinishjail97 vinishjail97 mentioned this pull request Oct 3, 2024
2 tasks
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.

3 participants