https://github.com/atp-mipt/export-maven-plugin
An Apache Maven plugin designed for exporting an entire Maven project into a .zip file
https://github.com/atp-mipt/export-maven-plugin
maven-plugin teaching-tools
Last synced: 8 months ago
JSON representation
An Apache Maven plugin designed for exporting an entire Maven project into a .zip file
- Host: GitHub
- URL: https://github.com/atp-mipt/export-maven-plugin
- Owner: atp-mipt
- License: mit
- Created: 2024-01-19T23:05:12.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2025-06-15T08:32:13.000Z (12 months ago)
- Last Synced: 2025-06-15T09:37:34.059Z (12 months ago)
- Topics: maven-plugin, teaching-tools
- Language: Java
- Homepage:
- Size: 38.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Export Maven Plugin
[](https://github.com/atp-mipt/export-maven-plugin/actions?query=workflow%3A"build")
[](https://maven-badges.herokuapp.com/maven-central/org.atp-fivt/export-maven-plugin)
The Export Maven Plugin is an Apache Maven plugin designed for exporting an entire Maven project into a .zip file. It respects the `.gitignore` settings and, regardless of `.gitignore`, always omits the build directory (`target`).
## Why is it needed?
Typically, archiving a project involves the following command:
```shell
git archive -o export.zip HEAD
```
However, in teaching environments, particularly when instructing large groups in Java, it's not always feasible to assume that Git is installed on all systems. In scenarios where Git is not part of the course curriculum, and lab/homework submissions are required in .zip format, it's important to ensure that students' submissions do not include unwanted files, such as those in the build folder or IDE-specific directories.
Since students are expected to use Maven and create their projects via [homework-quickstart archetype](https://github.com/atp-mipt/homework-quickstart), this simple plugin enables students to automatically export their projects in the required format without including unwanted files.
## How to use
To use the plugin, insert the following configuration into the plugins section of your pom.xml:
```xml
org.atp-fivt
export-maven-plugin
1.2
Name_Surname.zip
```
The `zipFileName` parameter allows you to specify the desired name for the zip file. By default, the file name is set to export.zip.
To run the plugin, execute:
```shell
mvn export:export
```
The resulting `.zip` file will be located in the target directory.
## How does it work
This plugin leverages the [jGit](https://www.eclipse.org/jgit/) library to compile a list of all files in the project, adhering to the rules specified in `.gitignore` files. Importantly, the functionality of this plugin does not require Git to be installed on the target machine. This is particularly beneficial in educational settings or environments where Git installation cannot be assumed. By using jGit, the plugin operates independently of the local Git installation.