Skip to content

Commit 135dcff

Browse files
committed
co-pilot suggested changes
1 parent 921eab6 commit 135dcff

8 files changed

Lines changed: 40 additions & 52 deletions

File tree

.skills/example-apps.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ Each example app declares the plugin as a regular dependency, just as an externa
2828

2929
```groovy
3030
dependencies {
31-
implementation project(':grails-server-timing')
31+
implementation project(':grails-plugin-template')
3232
}
3333
```
3434

.skills/plugin-project.md

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -41,27 +41,27 @@ plugin/
4141
│ ├── conf/
4242
│ │ ├── application.yml # Plugin-specific config defaults
4343
│ ├── controllers/ # Interceptors, controller-scoped artifacts
44-
│ │ └── org/grails/plugins/servertiming/
45-
│ │ └── ServerTimingInterceptor.groovy
44+
│ │ └── org/grails/plugins/exampleplugin/
45+
│ │ └── ExamplePluginInterceptor.groovy
4646
└── src/
4747
├── main/groovy/ # Core plugin classes
48-
│ └── org/grails/plugins/servertiming/
49-
│ ├── ServerTimingAutoConfiguration.groovy
50-
│ ├── ServerTimingFilter.groovy
51-
│ ├── ServerTimingGrailsPlugin.groovy
52-
│ ├── ServerTimingResponseWrapper.groovy
48+
│ └── org/grails/plugins/exampleplugin/
49+
│ ├── ExamplePluginAutoConfiguration.groovy
50+
│ ├── ExamplePluginFilter.groovy
51+
│ ├── ExamplePluginGrailsPlugin.groovy
52+
│ ├── ExamplePluginResponseWrapper.groovy
5353
│ ├── config/
5454
│ │ ├── EnabledCondition.groovy
55-
│ │ └── ServerTimingConfig.groovy
55+
│ │ └── ExamplePluginConfig.groovy
5656
│ └── core/
5757
│ ├── Metric.groovy
5858
│ └── TimingMetric.groovy
59-
├── main/resources/
59+
├── main/resources/
6060
│ ├── META-INF/spring
6161
│ │ └── org.springframework.boot.autoconfigure.AutoConfiguration.imports
62-
│ └── spring-configuration-metadata.json
62+
│ └── spring-configuration-metadata.json
6363
└── test/groovy/ # Unit tests ONLY
64-
└── org/grails/plugins/servertiming/
64+
└── org/grails/plugins/exampleplugin/
6565
├── MetricSpec.groovy
6666
└── TimingMetricSpec.groovy
6767
```

.skills/repository-structure.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -104,7 +104,7 @@ flows through convention plugins.
104104
plugins {
105105
id 'idea'
106106
id 'config.docs'
107-
id 'config.root-publish'
107+
id 'config.publish-root'
108108
}
109109
```
110110

CONTRIBUTING.md

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ Thank you for your interest in contributing! This guide will help you get starte
44

55
## Code of Conduct
66

7-
This project has a [Code of Conduct](CODE_OF_CONDUCT.md). By participating, you are expected to uphold it. Please report
7+
This project has a Code of Conduct. By participating, you are expected to uphold it. Please report
88
unacceptable behavior to the project maintainers.
99

1010
## Getting Started
@@ -152,8 +152,9 @@ categorize changes in release notes.
152152

153153
## Security Vulnerabilities
154154

155-
If you discover a security vulnerability, **do not open a public issue**. Please see [SECURITY.md](.github/SECURITY.md)
156-
for responsible disclosure instructions.
155+
If you discover a security vulnerability, **do not open a public issue**. Instead, please report it privately to the
156+
project maintainers and include details to help reproduce and assess the issue. Responsible disclosure helps us protect
157+
users while we investigate and prepare a fix.
157158

158159
## License
159160

README.md

Lines changed: 17 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -1,46 +1,33 @@
1-
[![Maven Central](https://img.shields.io/maven-central/v/io.github.gpc/grails-export)](https://img.shields.io/maven-central/v/io.github.gpc/grails-export)
2-
[![License](https://img.shields.io/github/license/gpc/grails-export)](https://www.apache.org/licenses/LICENSE-2.0)
3-
[![CI](https://github.com/gpc/grails-export/actions/workflows/ci.yml/badge.svg?event=push)](https://github.com/gpc/grails-export/actions/workflows/ci.yml)
1+
[![Maven Central](https://img.shields.io/maven-central/v/io.github.gpc/grails-plugin-template)](https://central.sonatype.com/artifact/io.github.gpc/grails-plugin-template)
2+
[![License](https://img.shields.io/github/license/grails-plugins/grails-plugin-template)](https://www.apache.org/licenses/LICENSE-2.0)
3+
[![CI](https://github.com/grails-plugins/grails-plugin-template/actions/workflows/ci.yml/badge.svg?event=push)](https://github.com/grails-plugins/grails-plugin-template/actions/workflows/ci.yml)
44

5-
Grails Export Plugin
6-
====================
5+
Grails Plugin Template
6+
======================
77

8-
The official Grails Export Plugin.
8+
A template repository for building Grails plugins with a standardised multi-project structure,
9+
automated CI/CD workflows, and publishing configuration.
910

10-
This plugin offers export functionality supporting different formats e.g. CSV, Excel (xls, xlsx),
11-
Open Document Spreadsheet, PDF and XML and can be extended to add additional formats.
11+
Use this repository as the starting point when creating a new Grails plugin under the
12+
`grails-plugins` or `gpc` organisations. It provides:
1213

13-
The user guide can be found here: 📚 [Documentation]
14+
- Multi-project Gradle build with convention plugins in `build-logic/`
15+
- An example Grails app under `examples/app1/` for integration testing
16+
- Automated dependency updates via Dependabot and Renovate
17+
- GitHub Actions workflows for CI, publishing, release notes, and documentation
1418

15-
This was previously forked from [Nathan Wells]
19+
The user guide can be found here: 📚 [Documentation]
1620

1721
## Installation
1822

1923
Add the following dependency to the `build.gradle` file:
2024

2125
### Grails 7.x
2226

23-
```
24-
dependencies {
25-
implementation("io.github.gpc:grails-export:7.0.0")
26-
}
27-
```
28-
29-
### Grails 5.x - 6.x
30-
31-
```
32-
dependencies {
33-
implementation("org.grails.plugins:export:2.0.0")
34-
}
35-
```
36-
37-
### Grails 3.x - 4.x
38-
39-
```
27+
```groovy
4028
dependencies {
41-
compile("org.grails.plugins:export:2.0.0")
29+
implementation("io.github.gpc:grails-plugin-template:1.0.0")
4230
}
4331
```
4432

45-
[Documentation]: https://gpc.github.io/grails-export/
46-
[Nathan Wells]: https://github.com/nwwells/grails-export
33+
[Documentation]: https://grails-plugins.github.io/grails-plugin-template/

examples/app1/grails-app/conf/application.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
grails:
33
profile: web-plugin
44
codegen:
5-
defaultPackage: grails.plugins.export
5+
defaultPackage: grails.plugins.template
66
info:
77
app:
88
name: '@info.app.name@'
@@ -81,15 +81,15 @@ environments:
8181
development:
8282
dataSource:
8383
dbCreate: create-drop
84-
url: jdbc:h2:mem:devDb;MVCC=TRUE;LOCK_TIMEOUT=10000;DB_CLOSE_ON_EXIT=FALSE
84+
url: jdbc:h2:mem:devDb;LOCK_TIMEOUT=10000;DB_CLOSE_ON_EXIT=FALSE
8585
test:
8686
dataSource:
8787
dbCreate: update
88-
url: jdbc:h2:mem:testDb;MVCC=TRUE;LOCK_TIMEOUT=10000;DB_CLOSE_ON_EXIT=FALSE
88+
url: jdbc:h2:mem:testDb;LOCK_TIMEOUT=10000;DB_CLOSE_ON_EXIT=FALSE
8989
production:
9090
dataSource:
9191
dbCreate: update
92-
url: jdbc:h2:prodDb;MVCC=TRUE;LOCK_TIMEOUT=10000;DB_CLOSE_ON_EXIT=FALSE
92+
url: jdbc:h2:prodDb;LOCK_TIMEOUT=10000;DB_CLOSE_ON_EXIT=FALSE
9393
properties:
9494
jmxEnabled: true
9595
initialSize: 5

examples/app1/grails-app/init/grails/plugins/template/Application.groovy

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
package grails.export
1+
package grails.plugins.template
22

33
import grails.boot.GrailsApp
44
import grails.boot.config.GrailsAutoConfiguration

plugin/src/main/groovy/grails/plugins/template/PluginTemplateGrailsPlugin.groovy

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ A Grails plugin Template, that can be used either as a starting point for a new
1717
'''
1818
def license = 'APACHE'
1919
def organization = [name: 'Grails Plugins', url: 'https://github.com/grails-plugins']
20-
def issueManagement = [system: 'Github', url: 'https://github.com/grails-plugins/grails-plugin-template/issues']
20+
def issueManagement = [system: 'GitHub', url: 'https://github.com/grails-plugins/grails-plugin-template/issues']
2121
def scm = [url: 'https://github.com/grails-plugins/grails-plugin-template/']
2222

2323
}

0 commit comments

Comments
 (0)