Skip to content

Commit 2de3e88

Browse files
committed
Add GitHub Actions CI pipeline
1 parent 6ec7cd3 commit 2de3e88

2 files changed

Lines changed: 63 additions & 0 deletions

File tree

.github/workflows/build.yml

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
name: Build and Test
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
pull_request:
9+
branches:
10+
- main
11+
12+
jobs:
13+
build:
14+
15+
runs-on: ubuntu-latest
16+
17+
steps:
18+
19+
- name: Checkout Code
20+
uses: actions/checkout@v4
21+
22+
- name: Set Up Java
23+
uses: actions/setup-java@v4
24+
with:
25+
distribution: temurin
26+
java-version: 21
27+
28+
- name: Build and Run Tests
29+
run: mvn clean test

HELP.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# Read Me First
2+
The following was discovered as part of building this project:
3+
4+
* The original package name 'com.spike.access-request-platform' is invalid and this project uses 'com.spike.access_request_platform' instead.
5+
6+
# Getting Started
7+
8+
### Reference Documentation
9+
For further reference, please consider the following sections:
10+
11+
* [Official Apache Maven documentation](https://maven.apache.org/guides/index.html)
12+
* [Spring Boot Maven Plugin Reference Guide](https://docs.spring.io/spring-boot/4.1.0/maven-plugin)
13+
* [Create an OCI image](https://docs.spring.io/spring-boot/4.1.0/maven-plugin/build-image.html)
14+
* [Spring Web](https://docs.spring.io/spring-boot/4.1.0/reference/web/servlet.html)
15+
* [Spring Data JPA](https://docs.spring.io/spring-boot/4.1.0/reference/data/sql.html#data.sql.jpa-and-spring-data)
16+
* [Validation](https://docs.spring.io/spring-boot/4.1.0/reference/io/validation.html)
17+
* [Spring Boot DevTools](https://docs.spring.io/spring-boot/4.1.0/reference/using/devtools.html)
18+
19+
### Guides
20+
The following guides illustrate how to use some features concretely:
21+
22+
* [Building a RESTful Web Service](https://spring.io/guides/gs/rest-service/)
23+
* [Serving Web Content with Spring MVC](https://spring.io/guides/gs/serving-web-content/)
24+
* [Building REST services with Spring](https://spring.io/guides/tutorials/rest/)
25+
* [Accessing Data with JPA](https://spring.io/guides/gs/accessing-data-jpa/)
26+
* [Validation](https://spring.io/guides/gs/validating-form-input/)
27+
28+
### Maven Parent overrides
29+
30+
Due to Maven's design, elements are inherited from the parent POM to the project POM.
31+
While most of the inheritance is fine, it also inherits unwanted elements like `<license>` and `<developers>` from the parent.
32+
To prevent this, the project POM contains empty overrides for these elements.
33+
If you manually switch to a different parent and actually want the inheritance, you need to remove those overrides.
34+

0 commit comments

Comments
 (0)