Skip to content

Be available as a Java Module #8

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.

Sign up for GitHub

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

Closed
wants to merge 6 commits into from
Closed

Be available as a Java Module #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
24b1a5b
wip
nahsra Sep 21, 2023
fcfd8fe
updated javadoc version to avoid module generation bug
nahsra Sep 21, 2023
0e94cb5
get rid of metafiles
nahsra Sep 21, 2023
45f182f
Autogenerated JaCoCo coverage badge
Sep 21, 2023
41d8964
remove badge updates now that branch restrictions are on
nahsra Sep 21, 2023
ba5a961
remove badges
nahsra Sep 21, 2023
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
1 change: 0 additions & 1 deletion .github/badges/branches.svg
View file
Open in desktop

This file was deleted.

1 change: 0 additions & 1 deletion .github/badges/jacoco.svg
View file
Open in desktop

This file was deleted.

27 changes: 1 addition & 26 deletions .github/workflows/build.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,29 +15,4 @@ jobs:
distribution: 'adopt'

- name: "Build with Maven"
run: mvn -Pci verify

- name: "Generate Coverage Badge"
id: jacoco
uses: cicirello/jacoco-badge-generator@v2
with:
generate-branches-badge: true

- name: "Log coverage percentage"
run: |
echo "coverage = ${{ steps.jacoco.outputs.coverage }}"
echo "branch coverage = ${{ steps.jacoco.outputs.branches }}"
- name: "Commit the JaCoCo badge (if it changed)"
run: |
if [[ `git status --porcelain` ]]; then
git config --global user.name 'Jacoco Coverage Update Action'
git config --global user.email '[email protected]'
git add -A
git commit -m "Autogenerated JaCoCo coverage badge"
git push
fi
- name: "Upload JaCoCo coverage report"
uses: actions/upload-artifact@v2
with:
name: jacoco-report
path: target/site/jacoco/
run: mvn -Pci verify
2 changes: 2 additions & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# Compiled class file
*.class

.DS_Store

# Log file
*.log

Expand Down
60 changes: 14 additions & 46 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@

<groupId>io.github.pixee</groupId>
<artifactId>java-security-toolkit</artifactId>
<version>1.0.7</version>
<version>1.0.8</version>

<name>java-security-toolkit</name>
<description>a library with common security controls</description>
Expand Down Expand Up @@ -58,17 +58,16 @@
<versions.maven-gpg-plugin>3.0.1</versions.maven-gpg-plugin>
<versions.jacoco-maven-plugin>0.8.7</versions.jacoco-maven-plugin>

<versions.maven-javadoc-plugin>2.9.1</versions.maven-javadoc-plugin>
<versions.maven-javadoc-plugin>3.6.0</versions.maven-javadoc-plugin>
<versions.nexus-staging-maven-plugin>1.6.13</versions.nexus-staging-maven-plugin>
</properties>

<dependencies>

<!-- needed for XSS escapers -->
<!-- needed for ValidatingObjectInputStream in deserialization -->
<dependency>
<groupId>com.coverity.security</groupId>
<artifactId>coverity-escapers</artifactId>
<version>1.1.1</version>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.13.0</version>
</dependency>

<!-- needed for command line parsers -->
Expand All @@ -78,24 +77,18 @@
<version>2.1</version>
</dependency>

<!-- needed for ValidatingObjectInputStream in deserialization -->
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.11.0</version>
</dependency>
<dependency>
<groupId>org.codehaus.mojo</groupId>
<artifactId>animal-sniffer-annotations</artifactId>
<version>1.23</version>
<optional>true</optional>
</dependency>
<!-- needed for testing deserialization protection -->
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.5</version>
<scope>test</scope>
<exclusions>
<exclusion>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
</exclusion>
</exclusions>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
Expand Down Expand Up @@ -162,30 +155,9 @@
<artifactId>maven-compiler-plugin</artifactId>
<version>${versions.maven-compiler-plugin}</version>
<configuration>
<source>8</source>
<target>8</target>
</configuration>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>animal-sniffer-maven-plugin</artifactId>
<version>1.23</version>
<configuration>
<signature>
<groupId>org.codehaus.mojo.signature</groupId>
<artifactId>java18</artifactId>
<version>1.0</version>
</signature>
<source>11</source>
Copy link
Contributor

@gilday gilday Sep 21, 2023

Choose a reason for hiding this comment

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

Prefer release to source and target. It does the same thing, but also includes the functionality that the animal sniffer was giving you (makes sure you don't use an API not available in the release you're targeting).

<target>11</target>
Copy link
Contributor

@gilday gilday Sep 21, 2023

Choose a reason for hiding this comment

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

I wouldn't be too quick to abandon the Java 8 users. We can try modulemaker maven plugin to generate the module-info, so that we don't need to upgrade our source to 11.

</configuration>
<executions>
<execution>
<id>animal-sniffer</id>
<phase>test</phase>
<goals>
<goal>check</goal>
</goals>
</execution>
</executions>
</plugin>
<plugin>
<groupId>org.jacoco</groupId>
Expand Down Expand Up @@ -276,10 +248,6 @@
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.codehaus.mojo</groupId>
<artifactId>animal-sniffer-maven-plugin</artifactId>
</plugin>
<plugin>
<groupId>org.jacoco</groupId>
<artifactId>jacoco-maven-plugin</artifactId>
Expand Down
Loading