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

Fixes docs structure and GitHub Action scripts #137

Merged
merged 2 commits into from
Apr 3, 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
14 changes: 11 additions & 3 deletions .github/workflows/build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,13 +22,21 @@ on:
- '*.txt'
- '.all-contributorsrc'

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

defaults:
run:
shell: bash

jobs:
build:
name: Build on ${{ matrix.os }}
strategy:
fail-fast: false
matrix:
# os: [windows-latest, macos-latest, ubuntu-latest]
# os: [windows-latest, macos-latest, ubuntu-latest]
os: [ubuntu-latest]
runs-on: ${{ matrix.os }}
steps:
Expand All @@ -45,7 +53,7 @@ jobs:
cache: 'maven'

- name: Build with Maven
run: mvn -B clean verify -Dno-format
run: mvn -B clean install -Dno-format

- name: Build with Maven (Native)
run: mvn -B verify -Dnative -Dquarkus.native.container-build -Dnative.surefire.skip
run: mvn -B install -Dnative -Dquarkus.native.container-build -Dnative.surefire.skip
44 changes: 20 additions & 24 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,14 @@ on:
paths:
- '.github/project.yml'

concurrency:
group: ${{ github.workflow }}-${{ github.ref }}
cancel-in-progress: true

defaults:
run:
shell: bash

jobs:
release:
runs-on: ubuntu-latest
Expand All @@ -24,9 +32,9 @@ jobs:

- name: Import GPG key
id: import_gpg
uses: crazy-max/ghaction-import-gpg@v3
uses: crazy-max/ghaction-import-gpg@v5
with:
gpg-private-key: ${{ secrets.GPG_PRIVATE_KEY }}
gpg_private_key: ${{ secrets.GPG_PRIVATE_KEY }}
passphrase: ${{ secrets.GPG_PASSPHRASE }}

- name: Set up JDK 11
Expand All @@ -44,35 +52,23 @@ jobs:
git config --local user.email "action@github.com"
git config --local user.name "GitHub Action"

- name: Maven release ${{steps.metadata.outputs.current-version}}
- name: Update latest release version in docs
run: |
git checkout -b release
mvn -B release:prepare -Prelease -DreleaseVersion=${{steps.metadata.outputs.current-version}} -DdevelopmentVersion=${{steps.metadata.outputs.next-version}}
mvn -B -ntp -pl docs -am generate-resources -Denforcer.skip -Dformatter.skip -Dimpsort.skip
if ! git diff --quiet docs/modules/ROOT/pages/includes/attributes.adoc; then
git add docs/modules/ROOT/pages/includes/attributes.adoc
git commit -m "Update stable version for documentation"
git commit -m "Update the latest release version ${{steps.metadata.outputs.current-version}} in documentation"
fi
git checkout ${{github.base_ref}}
git rebase release

- name: Maven release ${{steps.metadata.outputs.current-version}}
run: |
mvn -B release:prepare -Prelease -DreleaseVersion=${{steps.metadata.outputs.current-version}} -DdevelopmentVersion=${{steps.metadata.outputs.next-version}}
mvn -B release:perform -Darguments=-DperformRelease -DperformRelease -Prelease
env:
MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
MAVEN_PASSWORD: ${{ secrets.OSSRH_TOKEN }}

- name: Adjust tag for documentation changes
run: |
git checkout ${{steps.metadata.outputs.current-version}}
mvn -B clean install -DskipTests -DskipITs
if ! git diff --quiet docs/modules/ROOT/pages/includes/attributes.adoc; then
git add docs/modules/ROOT/pages/includes/attributes.adoc
git commit -m "Update stable version for documentation"
# Move the tag after inclusion of documentation adjustments
git tag -f ${{steps.metadata.outputs.current-version}}
# Push modified tag
git push origin refs/tags/${{steps.metadata.outputs.current-version}} -f
fi
# Go back to base branch
git checkout ${{github.base_ref}}

- name: Push changes to ${{github.base_ref}} branch
run: git push
run: |
git push
git push origin ${{steps.metadata.outputs.current-version}}
Empty file.
Empty file.
2 changes: 1 addition & 1 deletion docs/modules/ROOT/nav.adoc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
* xref:index.adoc[Quarkiverse <YOUR_PROJECT>]
* xref:index.adoc[Quarkus jOOQ]
112 changes: 0 additions & 112 deletions docs/modules/ROOT/pages/config.adoc

This file was deleted.

3 changes: 3 additions & 0 deletions docs/modules/ROOT/pages/includes/attributes.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
:project-version: 0.4.0
gastaldi marked this conversation as resolved.
Show resolved Hide resolved

:examples-dir: ./../examples/
140 changes: 140 additions & 0 deletions docs/modules/ROOT/pages/includes/quarkus-jooq.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@

:summaryTableId: quarkus-jooq
[.configuration-legend]
icon:lock[title=Fixed at build time] Configuration property fixed at build time - All other configuration properties are overridable at runtime
[.configuration-reference.searchable, cols="80,.^10,.^10"]
|===

h|[[quarkus-jooq_configuration]]link:#quarkus-jooq_configuration[Configuration property]

h|Type
h|Default

a|icon:lock[title=Fixed at build time] [[quarkus-jooq_quarkus.jooq.dialect]]`link:#quarkus-jooq_quarkus.jooq.dialect[quarkus.jooq.dialect]`

[.description]
--
The jOOQ dialect

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_JOOQ_DIALECT+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_JOOQ_DIALECT+++`
endif::add-copy-button-to-env-var[]
--|string
|required icon:exclamation-circle[title=Configuration property is required]


a|icon:lock[title=Fixed at build time] [[quarkus-jooq_quarkus.jooq.datasource]]`link:#quarkus-jooq_quarkus.jooq.datasource[quarkus.jooq.datasource]`

[.description]
--
The jOOQ dataSource

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_JOOQ_DATASOURCE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_JOOQ_DATASOURCE+++`
endif::add-copy-button-to-env-var[]
--|string
|


a|icon:lock[title=Fixed at build time] [[quarkus-jooq_quarkus.jooq.configuration]]`link:#quarkus-jooq_quarkus.jooq.configuration[quarkus.jooq.configuration]`

[.description]
--
The jOOQ configuration

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_JOOQ_CONFIGURATION+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_JOOQ_CONFIGURATION+++`
endif::add-copy-button-to-env-var[]
--|string
|


a|icon:lock[title=Fixed at build time] [[quarkus-jooq_quarkus.jooq.configuration-inject]]`link:#quarkus-jooq_quarkus.jooq.configuration-inject[quarkus.jooq.configuration-inject]`

[.description]
--
The jOOQ configuration by inject named

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_JOOQ_CONFIGURATION_INJECT+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_JOOQ_CONFIGURATION_INJECT+++`
endif::add-copy-button-to-env-var[]
--|string
|


a|icon:lock[title=Fixed at build time] [[quarkus-jooq_quarkus.jooq.-named-config-.dialect]]`link:#quarkus-jooq_quarkus.jooq.-named-config-.dialect[quarkus.jooq."named-config".dialect]`

[.description]
--
The jOOQ dialect

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_JOOQ__NAMED_CONFIG__DIALECT+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_JOOQ__NAMED_CONFIG__DIALECT+++`
endif::add-copy-button-to-env-var[]
--|string
|required icon:exclamation-circle[title=Configuration property is required]


a|icon:lock[title=Fixed at build time] [[quarkus-jooq_quarkus.jooq.-named-config-.datasource]]`link:#quarkus-jooq_quarkus.jooq.-named-config-.datasource[quarkus.jooq."named-config".datasource]`

[.description]
--
The jOOQ dataSource

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_JOOQ__NAMED_CONFIG__DATASOURCE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_JOOQ__NAMED_CONFIG__DATASOURCE+++`
endif::add-copy-button-to-env-var[]
--|string
|


a|icon:lock[title=Fixed at build time] [[quarkus-jooq_quarkus.jooq.-named-config-.configuration]]`link:#quarkus-jooq_quarkus.jooq.-named-config-.configuration[quarkus.jooq."named-config".configuration]`

[.description]
--
The jOOQ configuration

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_JOOQ__NAMED_CONFIG__CONFIGURATION+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_JOOQ__NAMED_CONFIG__CONFIGURATION+++`
endif::add-copy-button-to-env-var[]
--|string
|


a|icon:lock[title=Fixed at build time] [[quarkus-jooq_quarkus.jooq.-named-config-.configuration-inject]]`link:#quarkus-jooq_quarkus.jooq.-named-config-.configuration-inject[quarkus.jooq."named-config".configuration-inject]`

[.description]
--
The jOOQ configuration by inject named

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_JOOQ__NAMED_CONFIG__CONFIGURATION_INJECT+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_JOOQ__NAMED_CONFIG__CONFIGURATION_INJECT+++`
endif::add-copy-button-to-env-var[]
--|string
|

|===
9 changes: 5 additions & 4 deletions docs/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,19 @@ Describe what the extension does here.

== Installation

If you want to use this extension, you need to add the `quarkiverse-<YOUR_EXTENSION>` extension first.
If you want to use this extension, you need to add the `quarkiverse-jooq` extension first.
In your `pom.xml` file, add:

[source,xml]
----
<dependency>
<groupId>io.quarkiverse</groupId>
<artifactId>quarkiverse-freemarker</artifactId>
<groupId>io.quarkiverse.jooq</groupId>
<artifactId>quarkiverse-jooq</artifactId>
<version>{project-version}</version>
</dependency>
----

[[extension-configuration-reference]]
== Extension Configuration Reference

include::config.adoc[leveloffset=+1, opts=optional]
include::includes/quarkus-jooq.adoc[leveloffset=+1, opts=optional]
Loading