Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/bmuschko/gradle-tomcat-plugin

Gradle plugin supporting deployment of your web application to an embedded Tomcat web container
https://github.com/bmuschko/gradle-tomcat-plugin

deployment gradle-plugin tomcat web

Last synced: 3 months ago
JSON representation

Gradle plugin supporting deployment of your web application to an embedded Tomcat web container

Host: GitHub
URL: https://github.com/bmuschko/gradle-tomcat-plugin
Owner: bmuschko
License: apache-2.0
Archived: true
Created: 2010-11-30T03:34:42.000Z (almost 14 years ago)
Default Branch: master
Last Pushed: 2023-10-12T23:21:35.000Z (about 1 year ago)
Last Synced: 2024-06-20T14:17:42.192Z (5 months ago)
Topics: deployment, gradle-plugin, tomcat, web
Language: Groovy
Homepage:
Size: 1.66 MB
Stars: 532
Watchers: 44
Forks: 126
Open Issues: 28
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

awesome-gradle - gradle-tomcat-plugin - Support deployment of your web application to an embedded Tomcat web container. (Plugins / Web application development)

README

# Gradle Tomcat plugin [![Build Status](https://github.com/bmuschko/gradle-tomcat-plugin/workflows/Build%20and%20Release%20%5BLinux%5D/badge.svg)](https://github.com/bmuschko/gradle-tomcat-plugin/actions?query=workflow%3A%22Build+and+Release+%5BLinux%5D%22)

![Tomcat Logo](http://tomcat.apache.org/res/images/tomcat.png)

‼️ This project reached end of life (EOL) status due to its incompatibility with Gradle 9.0 and the wide adoption of modern Java frameworks like Spring Boot, Micronaut, and Quarkus that can be executed without and directly by Tomcat. No more feature requests and bug fixes will be considered. Please fork the repository and publish your own releases if you want to continue maintaining the plugin.

The plugin provides deployment capabilities of web applications to an embedded Tomcat web container in any given
Gradle build. It extends the [War plugin](https://docs.gradle.org/current/userguide/war_plugin.html). At the moment the Tomcat versions
6.0.x, 7.0.x, 8.0.x, 8.5.x and 9.0.x are supported.

The typical use case for this plugin is to support deployment during development. The plugin allows for rapid web application
development due to the container's fast startup times. Gradle starts the embedded container in the same JVM. Currently,
the container cannot be forked as a separate process. This plugin also can't deploy a WAR file to a remote container. If
you are looking for this capability, please have a look at the [Cargo plugin](https://github.com/bmuschko/gradle-cargo-plugin)
instead.

## Usage

To use the plugin's functionality, you will need to add the its binary artifact to your build script's classpath and apply the plugin.

### Adding the plugin binary to the build

The plugin JAR needs to be defined in the classpath of your build script. It is directly available on the Gradle plugin portal.
The following code snippet shows an example on how to retrieve it:

```groovy
buildscript {
repositories {
gradlePluginPortal()
}

dependencies {
classpath 'com.bmuschko:gradle-tomcat-plugin:2.7.0'
}
}
```

### Provided plugins

The JAR file comes with two plugins:

Plugin Identifier
Depends On
Type
Description

com.bmuschko.tomcat-base
-
TomcatBasePlugin
Provides Tomcat custom task types, pre-configures classpath.

com.bmuschko.tomcat
com.bmuschko.tomcat-base
TomcatPlugin
Provides tasks for starting and stopping an embedded Tomcat container and exposes extension named tomcat.

The `com.bmuschko.tomcat` plugin helps you get started quickly. If you are OK if the preconfigured tasks, this is the
preferable option. Most plugin users will go with this option. To use the Tomcat plugin, include the following code snippet
in your build script:

apply plugin: 'com.bmuschko.tomcat'

If you need full control over your tasks or don't want to go with the preconfigured tasks, you will want to use the `com.bmuschko.tomcat-base`
plugin. That might be the case if you want to set up the container solely for functional testing. The downside is that each task
has to be configured individually in your build script. To use the Tomcat base plugin, include the following code snippet
in your build script:

apply plugin: 'com.bmuschko.tomcat-base'

### Assigning the Tomcat libraries

Additionally, the Tomcat runtime libraries need to be added to the configuration `tomcat`. At the moment the Tomcat
versions 6.0.x, 7.0.x, 8.0.x, 8.5.x and 9.0.x are supported by the plugin. Make sure you don't mix up Tomcat libraries of different
versions.

**Tomcat 6.0.x:**