Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

run gh actions #6

Merged
merged 12 commits into from
Nov 27, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 35 additions & 0 deletions .github/workflows/maven.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven

# This workflow uses actions that are not certified by GitHub.
# They are provided by a third-party and are governed by
# separate terms of service, privacy policy, and support
# documentation.

name: Java CI with Maven

on:
push:
branches: [ "master" ]
pull_request:
branches: [ "master" ]

jobs:
build:
runs-on: ubuntu-latest
strategy:
matrix:
java: [ '17', '21' ]
name: Build with Java ${{ matrix.Java }}
steps:
- uses: actions/checkout@v4
- name: Set up JDK
uses: actions/setup-java@v3
with:
distribution: 'temurin'
java-version: ${{ matrix.java }}
cache: maven
- name: Build with Maven
run: |
mvn -v
mvn -B package --file pom.xml
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ tmp/
hs_err_pid*

# IntelliJ IDEA
**/*.iml
**/.idea/artifacts/
**/.idea/codeStyles/
**/.idea/dictionaries/
Expand Down
6 changes: 0 additions & 6 deletions .travis.yml

This file was deleted.

11 changes: 4 additions & 7 deletions README.adoc
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
= OpenAPI - code first or design first?

image:https://travis-ci.org/pe-st/apidocs.svg?branch=master["Build Status", link="https://travis-ci.org/pe-st/apidocs"]
image:https://github.com/pe-st/apidocs/actions/workflows/maven/badge.svg?branch=feature%2Fupdates["Build Status"]

== Overview

Expand All @@ -16,21 +16,19 @@ between the design-first and code-first approach.
Accompanying presentation at https://www.eclipsecon.org/europe2019[eclipsecon Europe 2019] :
https://www.eclipsecon.org/europe2019/sessions/microprofile-openapi-code-first-or-design-first[MicroProfile OpenAPI - code first or design first?]

The examples use https://quarkus.io/[Quarkus] and https://openliberty.io/[OpenLiberty] as servers
just because they not only support MicroProfile OpenAPI, but come also with an integrated UI.
The examples use https://quarkus.io/[Quarkus] as server
just because it not only supports MicroProfile OpenAPI, but comes also with an integrated UI.
But the examples should run with very few code changes in any MicroProfile compatible server.

=== Code First

* link:code-first-openapi-openliberty/README.md[code-first with OpenLiberty server and MicroProfile OpenAPI]
* link:code-first-openapi-quarkus/README.md[code-first with Quarkus server and MicroProfile OpenAPI]
* link:code-first-swagger/README.md[code-first with Swagger scanner running with Quarkus server]

=== Design First

* link:design-first-openapi-generator/README.md[design-first with OpenAPI Generator and Quarkus server]
* link:design-first-swagger-quarkus/README.md[design-first with Swagger Codegen and Quarkus server]
* link:design-first-swagger-openliberty/README.md[design-first with Swagger Codegen and OpenLiberty server]

== Project Structure

Expand All @@ -48,7 +46,7 @@ when the project dependencies are updated (like it happened when I updated from
(the txt suffix protects them from being recognized as Java files by the IDE and being reformatted),
allowing to compare the result of openapi-generator and swagger-codegen.

In addition all example projects have a `rest-api.http` file which allows to run some example HTTP
In addition, all example projects have a `rest-api.http` file which allows to run some example HTTP
request against a running service directly from within IntelliJ. And there is an `_idea` directory
containing the IntelliJ project setup. But you can import the projects easily in any IDE with Maven
support.
Expand Down Expand Up @@ -89,4 +87,3 @@ Code, Documentation and Annotations generated from the same information
** https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md[OpenAPI Specification (OpenAPI Initiative)]
** https://swagger.io/specification/[OpenAPI Specification (Swagger)]
* https://quarkus.io/guides/openapi-swaggerui-guide[Quarkus - Using OpenAPI and Swagger UI]
* https://openliberty.io/guides/microprofile-openapi.html[OpenLiberty Guide - Documenting RESTful APIs]
9 changes: 0 additions & 9 deletions _idea/.idea/_idea.iml

This file was deleted.

4 changes: 1 addition & 3 deletions _idea/.idea/compiler.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

14 changes: 12 additions & 2 deletions _idea/.idea/encodings.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 2 additions & 1 deletion _idea/.idea/misc.xml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

This file was deleted.

This file was deleted.

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

This file was deleted.

This file was deleted.

This file was deleted.

20 changes: 0 additions & 20 deletions code-first-openapi-openliberty/README.md

This file was deleted.

Loading