Skip to content

Commit 1c09115

Browse files
Copilotafranken
andcommitted
Add Makefile targets and update markdown to use make commands
Co-authored-by: afranken <763000+afranken@users.noreply.github.com>
1 parent 9fcdca2 commit 1c09115

File tree

11 files changed

+44
-40
lines changed

11 files changed

+44
-40
lines changed

.claude/skills/implement/SKILL.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,12 +32,12 @@ Follow **DTO → Store → Service → Controller** (see AGENTS.md Architecture)
3232
- [ ] Read root + module `AGENTS.md` (required before any other step)
3333
- [ ] Identify the S3 API operation ([AWS docs](https://docs.aws.amazon.com/AmazonS3/latest/API/Welcome.html))
3434
- [ ] Review existing similar implementations
35-
- [ ] Run `./mvnw ktlint:format` then `./mvnw clean install`
35+
- [ ] Run `make format` then `make install`
3636
- [ ] Invoke the **`test` skill** to add/update unit and integration tests
3737
- [ ] Invoke the **`document` skill** to update `CHANGELOG.md`, `README.md`, and `AGENTS.md`
3838

3939
## Troubleshooting
4040

41-
- **Build fails**: Check Java 25, run `./mvnw ktlint:format`
41+
- **Build fails**: Check Java 25, run `make format`
4242
- **Tests fail**: Ensure XML matches AWS API exactly — run integration tests
43-
- **Docker fails**: Try `./mvnw clean install -DskipDocker` to isolate
43+
- **Docker fails**: Try `make skip-docker` to isolate

.claude/skills/refactor/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ Document what, why, and gotchas. Link to AWS API docs where relevant. See **[doc
3434
## Checklist
3535

3636
- [ ] No behavior changes — tests still pass
37-
- [ ] Run `./mvnw ktlint:format`
37+
- [ ] Run `make format`
3838
- [ ] Comments explain *why*, not *what*
3939
- [ ] Public APIs have KDoc
4040
- [ ] Names are self-documenting

.claude/skills/test/SKILL.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,4 +24,4 @@ Read **[docs/TESTING.md](../../../docs/TESTING.md)**, **[docs/KOTLIN.md](../../.
2424
- [ ] Both success and failure cases covered
2525
- [ ] Tests are independent (no shared state, UUID bucket names)
2626
- [ ] Assertions are specific
27-
- [ ] Run `./mvnw ktlint:format`
27+
- [ ] Run `make format`

.github/CONTRIBUTING.md

Lines changed: 6 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -21,17 +21,10 @@ All third-party contributions to this project must be accompanied by a signed co
2121

2222
**Build and verify:**
2323
```shell
24-
# Full build with Docker
25-
./mvnw clean install
26-
27-
# Skip Docker (faster, for unit tests only)
28-
./mvnw clean install -DskipDocker
29-
30-
# Run integration tests
31-
./mvnw verify -pl integration-tests
32-
33-
# Format Kotlin code
34-
./mvnw ktlint:format
24+
make install # Full build with Docker
25+
make skip-docker # Skip Docker (faster, for unit tests only)
26+
make integration-tests # Run integration tests
27+
make format # Format Kotlin code
3528
```
3629

3730
## Architecture
@@ -45,8 +38,8 @@ Module-specific documentation:
4538

4639
## Code Style
4740

48-
- **Kotlin**: Enforced by ktlint - run `./mvnw ktlint:format` before submitting
49-
- **XML/Java**: Enforced by Checkstyle - configuration in [`etc/checkstyle.xml`](../etc/checkstyle.xml)
41+
- **Kotlin**: Enforced by ktlint run `make format` before submitting
42+
- **XML/Java**: Enforced by Checkstyle configuration in [`etc/checkstyle.xml`](../etc/checkstyle.xml)
5043
- **Key conventions**: Constructor injection, data classes for DTOs, backtick test names, `val` over `var`
5144
- See the DO / DON'T section in [AGENTS.md](../AGENTS.md) for the full list
5245

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,6 @@
99

1010
- [ ] I have signed the [CLA](http://adobe.github.io/cla.html).
1111
- [ ] I have written tests and verified that they fail without my change.
12-
- [ ] I have run `./mvnw ktlint:format` to fix code style.
12+
- [ ] I have run `make format` to fix code style.
1313
- [ ] I have updated `CHANGELOG.md` (if applicable).
1414
- [ ] I have updated documentation (if applicable).

AGENTS.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -98,10 +98,10 @@ See **[docs/TESTING.md](docs/TESTING.md)** for the full testing strategy, base c
9898
## Build
9999

100100
```bash
101-
./mvnw clean install # Full build
102-
./mvnw clean install -DskipDocker # Skip Docker
103-
./mvnw verify -pl integration-tests
104-
./mvnw ktlint:format
101+
make install # Full build
102+
make skip-docker # Skip Docker
103+
make integration-tests # Run integration tests
104+
make format # Format Kotlin code
105105
```
106106

107107
## CI/CD Pipeline

Makefile

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
# limitations under the License.
1515
#
1616

17-
.PHONY: build verify install sort
17+
.PHONY: build verify install skip-docker format integration-tests run test sort
1818
.DEFAULT_GOAL := build
1919

2020
build: verify
@@ -25,5 +25,20 @@ verify:
2525
install:
2626
./mvnw -B -V -Dstyle.color=always clean install
2727

28+
skip-docker:
29+
./mvnw -B -V -Dstyle.color=always clean install -DskipDocker
30+
31+
format:
32+
./mvnw -B -V -Dstyle.color=always ktlint:format
33+
34+
integration-tests:
35+
./mvnw -B -V -Dstyle.color=always verify -pl integration-tests
36+
37+
run:
38+
./mvnw spring-boot:run -pl server
39+
40+
test:
41+
./mvnw -B -V -Dstyle.color=always test -pl server
42+
2843
sort:
2944
./mvnw -B -V -Dstyle.color=always com.github.ekryd.sortpom:sortpom-maven-plugin:sort

README.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -484,17 +484,13 @@ graph LR
484484

485485
**Build:**
486486
```shell
487-
# Full build with Docker
488-
./mvnw clean install
489-
490-
# Skip Docker build
491-
./mvnw clean install -DskipDocker
487+
make install # Full build with Docker
488+
make skip-docker # Skip Docker build
492489
```
493490

494491
**Run from source:**
495492
```shell
496-
# As Spring Boot application
497-
./mvnw spring-boot:run -pl server
493+
make run # As Spring Boot application
498494
499495
# As Docker container
500496
./mvnw clean package -pl server -am -DskipTests
@@ -503,7 +499,7 @@ docker run -p 9090:9090 -p 9191:9191 adobe/s3mock:latest
503499

504500
**Run integration tests:**
505501
```shell
506-
./mvnw verify -pl integration-tests
502+
make integration-tests
507503
```
508504

509505
**Technology:**

docs/TESTING.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -80,11 +80,11 @@ See **[docs/KOTLIN.md](KOTLIN.md)** for Kotlin naming conventions (backtick test
8080
## Running Tests
8181

8282
```bash
83-
./mvnw test -pl server # Unit tests only
84-
./mvnw verify -pl integration-tests # All integration tests
85-
./mvnw verify -pl integration-tests -Dit.test=BucketIT # Specific class
86-
./mvnw verify -pl integration-tests -Dit.test=BucketIT#shouldCreateBucket # Specific method
87-
./mvnw test -pl server -DskipDocker # Skip Docker
83+
make test # Unit tests only
84+
make integration-tests # All integration tests
85+
./mvnw verify -pl integration-tests -Dit.test=BucketIT # Specific class
86+
./mvnw verify -pl integration-tests -Dit.test=BucketIT#shouldCreateBucket # Specific method
87+
./mvnw test -pl server -DskipDocker # Skip Docker
8888
```
8989

9090
> Integration tests require Docker to be running.
@@ -102,4 +102,4 @@ See **[docs/KOTLIN.md](KOTLIN.md)** for Kotlin naming conventions (backtick test
102102
- [ ] Both success and failure cases covered
103103
- [ ] Tests are independent (no shared state, UUID bucket names)
104104
- [ ] Assertions are specific
105-
- [ ] Run `./mvnw ktlint:format`
105+
- [ ] Run `make format`

integration-tests/AGENTS.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Extend `S3TestBase` for access to:
2929
## Running
3030

3131
```bash
32-
./mvnw verify -pl integration-tests
32+
make integration-tests
3333
./mvnw verify -pl integration-tests -Dit.test=BucketIT
3434
./mvnw verify -pl integration-tests -Dit.test=BucketIT#shouldCreateBucket
3535
```

0 commit comments

Comments
 (0)