https://github.com/yunabraska/java-info-action
Fast Maven/Gradle parser. This dynamic GitHub action automatically detects and extracts crucial information such as Java version, project version, and encoding. It also provides essential build commands and properties to make your development process more independent, efficient and streamlined.
https://github.com/yunabraska/java-info-action
build-script github-actions gradle information-retrieval java java-version maven parser project-version
Last synced: 8 days ago
JSON representation
Fast Maven/Gradle parser. This dynamic GitHub action automatically detects and extracts crucial information such as Java version, project version, and encoding. It also provides essential build commands and properties to make your development process more independent, efficient and streamlined.
- Host: GitHub
- URL: https://github.com/yunabraska/java-info-action
- Owner: YunaBraska
- License: apache-2.0
- Created: 2022-11-19T07:31:59.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-05-01T08:28:20.000Z (9 months ago)
- Last Synced: 2025-05-05T02:56:28.331Z (9 months ago)
- Topics: build-script, github-actions, gradle, information-retrieval, java, java-version, maven, parser, project-version
- Language: TypeScript
- Homepage: https://github.com/marketplace/actions/java-info-action
- Size: 38.2 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# java-info-action
Fast Maven/Gradle parser.
This dynamic GitHub action automatically detects and extracts crucial information such as Java version, project version,
and encoding.
It also provides essential build commands and properties to make your development process more independent, efficient
and streamlined.
_List of dependencies and their licenses: [licenses.csv](https://github.com/YunaBraska/java-info-action/blob/main/licenses.csv)._
[](https://github.com/sponsors/YunaBraska)
[![Build][build_shield]][build_link]
[![Maintainable][maintainable_shield]][maintainable_link]
[![Coverage][coverage_shield]][coverage_link]
[![Issues][issues_shield]][issues_link]
[![Commit][commit_shield]][commit_link]
[![License][license_shield]][license_link]
[![Tag][tag_shield]][tag_link]
[![Size][size_shield]][size_shield]
![Label][label_shield]
![Label][node_version]
[](https://github.com/YunaBraska/java-info-action/blob/main/dist/licenses.txt)
### Features
* *This action does not use any maven / gradle commands* therefore no java, maven or gradle is needed.
* **JENV** `.java-version` and **ASDF** `.tool-versions` will be taken as a fallback
* update Shields/Badges see [ShieldsDemo](./ShieldDemo.md)
## Usage
```yaml
# RUNNER
- name: "Read Java Info"
id: "java_info"
uses: YunaBraska/java-info-action@main
# CONFIGS (Optional)
with:
deep: '-1'
work-dir: '.'
jv-fallback: 17
pv-fallback: '0.0.1'
pe-fallback: 'utf-8'
custom-gradle-cmd: "clean build"
custom-maven-cmd: "clean package"
# PRINT
- name: "Print Java Version"
run: |
echo "java_version [${{ steps.java_info.outputs.java_version }}]"
echo "artifact_name [${{ steps.java_info.outputs.artifact_name }}]"
echo "project_version [${{ steps.java_info.outputs.project_version }}]"
echo "project_encoding [${{ steps.java_info.outputs.project_encoding }}]"
echo "cmd_custom [${{ steps.java_info.outputs.cmd_custom }}]"
echo "is_gradle [${{ steps.java_info.outputs.is_gradle }}]"
echo "is_maven [${{ steps.java_info.outputs.is_maven }}]"
echo "has_wrapper [${{ steps.java_info.outputs.has_wrapper }}]"
echo "builder_name [${{ steps.java_info.outputs.builder_name }}]"
echo "x_sourceCompatibility [${{ steps.java_info.outputs.x_sourceCompatibility }}]"
echo "x_project_build_finalName [${{ steps.java_info.outputs.x_project_build_finalName }}]"
echo "x_groovyOptions_encoding [${{ steps.java_info.outputs.x_groovyOptions_encoding }}]"
echo "x_net_minidev_json-smart_version [${{ steps.java_info.outputs.x_project_dependencies_dependency_net_minidev_json-smart_version }}]"
# SETUP JAVA
- name: "Setup Java"
uses: actions/setup-java@main
with:
java-version: ${{ steps.java_info.outputs.java_version }}
distribution: 'adopt'
# RUN TESTS
- name: "Run tests"
run: sh ${{ steps.java_info.outputs.cmd_test }}
```
* Hint for multi-modules: The highest java version will win the race.
### Inputs
| parameter | default | description |
|-------------------|--------------|-------------------------------------------------------------------------------------|
| work-dir | '.' | folder scan ('.' == current) |
| deep | -1 | folder scan deep (-1 == endless) |
| jv-fallback | | fallback for "java_version" if no java version was found |
| pv-fallback | null | fallback for "project_version" if no project version was found |
| pe-fallback | utf-8 | fallback for "project_encoding" if no project encoding was found |
| custom-maven-cmd | '' | custom command for output "cmd_custom" which adds automatically gradle/maven prefix |
| custom-gradle-cmd | '' | custom command for output "cmd_custom" which adds automatically gradle/maven prefix |
| null-to-empty | '' | converts null to empty string |
### Outputs
| Name | default | description |
|---------------------|--------------|------------------------------------------------------------------------------------------------------------|
| java_version | | java version - parsed from build files e.g. 6,7,8,9,10,11 |
| java_version_legacy | | java version - parsed from build files e.g. 1.6,1.7,1.8,1.9,10,11 |
| project_version | null | project version - parsed from build files e.g. 1.2.3 |
| project_encoding | null | project encoding - parsed from build files e.g. utf-8 |
| has_wrapper | false | if a wrapper exists - e.g. gradlew, mvnw,... |
| builder_name | null | Name of the builder \[Gradle, Maven, null] |
| builder_version | null | version of the wrapper |
| builder_folder | null | build folder |
| is_gradle | false | true if a gradle build file was found |
| is_maven | false | true if a maven build file was found |
| artifact_name | - | artifact name if defined e.g. "archiveFileName, baseName, finalName" |
| artifact_name_jar | - | artifact name ending with ".jar" if defined e.g. "archiveFileName, baseName, finalName" |
| cmd | - | command e.g.
* gradle / gradlew / gradle.bat
* mvn / mvnw / mvn.bat |
| cmd_custom | - | Concatenation of 'cmd' + 'custom-gradle-cmd' or 'custom-maven-cmd' |
| cmd_test | - | command e.g.
* gradle clean test
* mvn clean test |
| cmd_build | - | command e.g.
* gradle clean build -x test
* mvn clean package -DskipTests |
| cmd_test_build | - | command e.g.
* gradle clean build
* mvn clean package |
| cmd_update_deps | - | command e.g.
* gradle check
* mvn versions:use-latest-versions -B -q -DgenerateBackupPoms=false |
| cmd_update_plugs | - | command e.g.
* gradle check
* mvn versions:use-latest-versions -B -q -DgenerateBackupPoms=false |
| cmd_update_props | - | command e.g.
* gradle check
* mvn versions:update-properties -B -q -DgenerateBackupPoms=false |
| cmd_update_parent | - | command e.g.
* gradle check
* mvn versions:update-parent -B -q -DgenerateBackupPoms=false |
| cmd_resolve_deps | - | command e.g.
* gradle --refresh-dependencies
* mvn -B -q dependency:go-offline -B -q |
| cmd_update_wrapper | - | command
* gradle wrapper --gradle-version latest
* mvn -B -q wrapper:wrapper |
| x_\ | - | other unhandled build script properties. These differs between maven an gradle |
### \[DEV] Setup Environment
* Use NodeJs 20
* Build: `npm run build` to "compile" `index.ts` to `./lib/index.js` && generate `licenses.csv`
* Test: `npm run test`
* _clean environment: `./clean_node.sh`_
[build_shield]: https://github.com/YunaBraska/java-info-action/workflows/RELEASE/badge.svg
[build_link]: https://github.com/YunaBraska/java-info-action/actions/workflows/publish.yml/badge.svg
[maintainable_shield]: https://img.shields.io/codeclimate/maintainability/YunaBraska/java-info-action?style=flat-square
[maintainable_link]: https://codeclimate.com/github/YunaBraska/java-info-action/maintainability
[coverage_shield]: https://img.shields.io/codeclimate/coverage/YunaBraska/java-info-action?style=flat-square
[coverage_link]: https://codeclimate.com/github/YunaBraska/java-info-action/test_coverage
[issues_shield]: https://img.shields.io/github/issues/YunaBraska/java-info-action?style=flat-square
[issues_link]: https://github.com/YunaBraska/java-info-action/commits/main
[commit_shield]: https://img.shields.io/github/last-commit/YunaBraska/java-info-action?style=flat-square
[commit_link]: https://github.com/YunaBraska/java-info-action/issues
[license_shield]: https://img.shields.io/github/license/YunaBraska/java-info-action?style=flat-square
[license_link]: https://github.com/YunaBraska/java-info-action/blob/main/LICENSE
[tag_shield]: https://img.shields.io/github/v/tag/YunaBraska/java-info-action?style=flat-square
[tag_link]: https://github.com/YunaBraska/java-info-action/releases
[size_shield]: https://img.shields.io/github/repo-size/YunaBraska/java-info-action?style=flat-square
[label_shield]: https://img.shields.io/badge/Yuna-QueenInside-blueviolet?style=flat-square
[gitter_shield]: https://img.shields.io/gitter/room/YunaBraska/java-info-action?style=flat-square
[gitter_link]: https://gitter.im/java-info-action/Lobby
[node_version]: https://img.shields.io/badge/node-20-blueviolet?style=flat-square