Skip to content

Commit

Permalink
* #111: Added links to the API documentation. (#112)
Browse files Browse the repository at this point in the history
 * #111: Added links to the API documentation.
  • Loading branch information
AnastasiiaSergienko authored Apr 28, 2021
1 parent 3826099 commit b5ae2cd
Show file tree
Hide file tree
Showing 12 changed files with 239 additions and 98 deletions.
17 changes: 17 additions & 0 deletions .github/workflows/broken_links_checker.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
name: Broken Links Checker

on:
schedule:
- cron: "0 5 * * *"
push:

jobs:
linkChecker:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: lychee Link Checker
id: lc
uses: lycheeverse/[email protected]
- name: Fail if there were link errors
run: exit ${{ steps.lc.outputs.exit_code }}
36 changes: 0 additions & 36 deletions .github/workflows/github_release.yml

This file was deleted.

34 changes: 34 additions & 0 deletions .github/workflows/release_droid_prepare_original_checksum.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
name: Release Droid - Prepare Original Checksum

on:
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout the repository
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Set up JDK 11
uses: actions/setup-java@v1
with:
java-version: 11
- name: Cache local Maven repository
uses: actions/cache@v2
with:
path: ~/.m2/repository
key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
restore-keys: |
${{ runner.os }}-maven-
- name: Run tests and build with Maven
run: mvn -B clean verify --file pom.xml
- name: Prepare checksum
run: find target -maxdepth 1 -name *.jar -exec sha256sum "{}" + > original_checksum
- name: Upload checksum to the artifactory
uses: actions/upload-artifact@v2
with:
name: original_checksum
retention-days: 5
path: original_checksum
29 changes: 29 additions & 0 deletions .github/workflows/release_droid_print_quick_checksum.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Release Droid - Print Quick Checksum

on:
workflow_dispatch:

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout the repository
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Set up JDK 11
uses: actions/setup-java@v1
with:
java-version: 11
- name: Cache local Maven repository
uses: actions/cache@v2
with:
path: ~/.m2/repository
key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
restore-keys: |
${{ runner.os }}-maven-
- name: Build with Maven skipping tests
run: mvn -B clean verify -DskipTests
- name: Print checksum
run: echo 'checksum_start==';find target -maxdepth 1 -name *.jar -exec sha256sum "{}" + | xargs;echo '==checksum_end'

Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Maven Central Release
name: Release Droid - Release On Maven Central

on:
workflow_dispatch:
Expand All @@ -7,7 +7,10 @@ jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Checkout the repository
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Set up Maven Central Repository
uses: actions/setup-java@v1
with:
Expand All @@ -29,4 +32,4 @@ jobs:
env:
MAVEN_USERNAME: ${{ secrets.OSSRH_USERNAME }}
MAVEN_PASSWORD: ${{ secrets.OSSRH_PASSWORD }}
run: mvn clean -Dgpg.skip=false -Dgpg.passphrase=${{ secrets.OSSRH_GPG_SECRET_KEY_PASSWORD }} deploy
run: mvn clean -Dgpg.skip=false -Dgpg.passphrase=${{ secrets.OSSRH_GPG_SECRET_KEY_PASSWORD }} -DskipTests deploy
35 changes: 35 additions & 0 deletions .github/workflows/release_droid_upload_github_release_assets.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
name: Release Droid - Upload GitHub Release Assets

on:
workflow_dispatch:
inputs:
upload_url:
description: 'Assets upload URL'
required: true

jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout the repository
uses: actions/checkout@v2
with:
fetch-depth: 0
- name: Set up JDK 11
uses: actions/setup-java@v1
with:
java-version: 11
- name: Cache local Maven repository
uses: actions/cache@v2
with:
path: ~/.m2/repository
key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
restore-keys: |
${{ runner.os }}-maven-
- name: Build with Maven skipping tests
run: mvn clean verify -DskipTests
- name: Upload assets to the GitHub release draft
uses: shogo82148/actions-upload-release-asset@v1
with:
upload_url: ${{ github.event.inputs.upload_url }}
asset_path: target/*.jar
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ If you are a programmer, a code contribution in form of an automatic unit test c
Maybe you are good at explaining how to use the SQL Statement Builder to end users? Help us improve the [user guide](doc/user_guide.md)!

## Ideas
Last but not least if you have ideas for ways to improve or extend OFT, feel free to write a [feature request](hhttps://github.com/EXASOL/sql-statement-builder/issues/new?template=Feature_request.md).
Last but not least if you have ideas for ways to improve or extend OFT, feel free to write a [feature request](https://github.com/EXASOL/sql-statement-builder/issues/new?template=Feature_request.md).

# Style Guides
We want the SQL Statement Builder to have a professional and uniform coding style. Formatter rules for Eclipse are part of the project. If you use a different editor, please make sure to match the current code formatting.
Expand Down
40 changes: 4 additions & 36 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# sql-statement-builder
# SQL Statement Builder

![exasol-testcontainers logo](doc/images/sql-statement-builder_128x128.png)

Expand Down Expand Up @@ -51,44 +51,12 @@ final String sql = renderer.render();
"Users" from the perspective of the `sql-statement-builder` are developers integrating the module into their own software.

* [User Guide](doc/user_guide/user_guide.md)
* [API Documentation](https://javadoc.io/doc/com.exasol/sql-statement-builder)
* [API Documentation](https://exasol.github.io/sql-statement-builder/index.html)
* [MIT License](LICENSE)
* [Changelog](doc/changes/changelog.md)
* [Dependencies](dependencies.md)

### Information for Developers

* [System Requirement Specification](doc/system_requirements.md)
* [Design](doc/design.md)

## Dependencies

### Test Dependencies

| Dependency | Purpose | License |
---------------------------------------------------------------------------------|--------------------------------------------------------|--------------------------------
| [Apache Maven](https://maven.apache.org/) | Build tool | Apache License 2.0 |
| [Equals Verifier](https://github.com/jqno/equalsverifier) | Automatic contract checker for `equals()` and `hash()` | Apache License 2.0 |
| [Hamcrest](http://hamcrest.org/) | Advanced matchers for JUnit | GNU BSD-3-Clause |
| [JUnit 5](https://junit.org/junit5/) | Unit testing framework | Eclipse Public License 1.0 |
| [Mockito](http://site.mockito.org/) | Mocking framework | MIT License |

### Maven Plug-ins

| Plug-in | Purpose | License |
---------------------------------------------------------------------------------|--------------------------------------------------------|--------------------------------
| [Maven Compiler Plugin][maven-compiler-plugin] | Setting required Java version | Apache License 2.0 |
| [Maven GPG Plugin](https://maven.apache.org/plugins/maven-gpg-plugin/) | Signs JARs | Apache License 2.0 |
| [Maven Enforcer Plugin][maven-enforcer-plugin] | Controlling environment constants | Apache License 2.0 |
| [Maven Jacoco Plugin](https://www.eclemma.org/jacoco/trunk/doc/maven.html) | Code coverage metering | Eclipse Public License 2.0 |
| [Maven JavaDoc Plugin](https://maven.apache.org/plugins/maven-javadoc-plugin/) | Creates JavaDoc JARs | Apache License 2.0 |
| [Maven Source Plugin](https://maven.apache.org/plugins/maven-source-plugin/) | Creates source JARs | Apache License 2.0 |
| [Maven Surefire Plugin][maven-surefire-plugin] | Unit testing | Apache License 2.0 |
| [OFT Maven Plugin](https://github.com/itsallcode/openfasttrace-maven-plugin) | Requirement tracing | GPL 3.0 |
| [Sonatype OSS Index Maven Plugin][sonatype-oss-index-maven-plugin] | Checking Dependencies Vulnerability | ASL2 |
| [Versions Maven Plugin][versions-maven-plugin] | Checking if dependencies updates are available | Apache License 2.0 |

[maven-compiler-plugin]: https://maven.apache.org/plugins/maven-compiler-plugin/
[maven-enforcer-plugin]: http://maven.apache.org/enforcer/maven-enforcer-plugin/
[maven-surefire-plugin]: https://maven.apache.org/surefire/maven-surefire-plugin/
[sonatype-oss-index-maven-plugin]: https://sonatype.github.io/ossindex-maven/maven-plugin/
[versions-maven-plugin]: https://www.mojohaus.org/versions-maven-plugin/
* [Design](doc/design.md)
73 changes: 73 additions & 0 deletions dependencies.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,73 @@
<!-- @formatter:off -->
# Dependencies

## Test Dependencies

| Dependency | License |
| ------------------------------- | -------------------------------- |
| [JUnit Jupiter (Aggregator)][0] | [Eclipse Public License v2.0][1] |
| [Hamcrest All][2] | [New BSD License][3] |
| [mockito-core][4] | [The MIT License][5] |
| [mockito-junit-jupiter][4] | [The MIT License][5] |
| [EqualsVerifier][8] | [Apache License, Version 2.0][9] |

## Plugin Dependencies

| Dependency | License |
| ------------------------------------------------------- | --------------------------------------------- |
| [Apache Maven Compiler Plugin][10] | [Apache License, Version 2.0][11] |
| [JaCoCo :: Maven Plugin][12] | [Eclipse Public License 2.0][13] |
| [Maven Surefire Plugin][14] | [Apache License, Version 2.0][11] |
| [Apache Maven Source Plugin][16] | [Apache License, Version 2.0][11] |
| [Apache Maven Javadoc Plugin][18] | [Apache License, Version 2.0][11] |
| [Apache Maven GPG Plugin][20] | [Apache License, Version 2.0][9] |
| [OpenFastTrace Maven Plugin][22] | [GNU General Public License v3.0][23] |
| [org.sonatype.ossindex.maven:ossindex-maven-plugin][24] | [ASL2][9] |
| [Versions Maven Plugin][26] | [Apache License, Version 2.0][11] |
| [Apache Maven Enforcer Plugin][28] | [Apache License, Version 2.0][11] |
| [Nexus Staging Maven Plugin][30] | [Eclipse Public License][31] |
| [Project keeper maven plugin][32] | [MIT][33] |
| [Maven Failsafe Plugin][34] | [Apache License, Version 2.0][11] |
| [Maven Deploy Plugin][36] | [The Apache Software License, Version 2.0][9] |
| [error-code-crawler-maven-plugin][38] | [MIT][33] |
| [Reproducible Build Maven Plugin][40] | [Apache 2.0][9] |
| [Maven Clean Plugin][42] | [The Apache Software License, Version 2.0][9] |
| [Maven Resources Plugin][44] | [The Apache Software License, Version 2.0][9] |
| [Maven JAR Plugin][46] | [The Apache Software License, Version 2.0][9] |
| [Maven Install Plugin][48] | [The Apache Software License, Version 2.0][9] |
| [Maven Site Plugin 3][50] | [The Apache Software License, Version 2.0][9] |

[12]: https://www.eclemma.org/jacoco/index.html
[32]: https://github.com/exasol/project-keeper-maven-plugin
[2]: https://github.com/hamcrest/JavaHamcrest
[9]: http://www.apache.org/licenses/LICENSE-2.0.txt
[14]: https://maven.apache.org/surefire/maven-surefire-plugin/
[30]: http://www.sonatype.com/public-parent/nexus-maven-plugins/nexus-staging/nexus-staging-maven-plugin/
[42]: http://maven.apache.org/plugins/maven-clean-plugin/
[4]: https://github.com/mockito/mockito
[33]: https://opensource.org/licenses/MIT
[34]: https://maven.apache.org/surefire/maven-failsafe-plugin/
[26]: http://www.mojohaus.org/versions-maven-plugin/
[10]: https://maven.apache.org/plugins/maven-compiler-plugin/
[20]: http://maven.apache.org/plugins/maven-gpg-plugin/
[22]: https://github.com/itsallcode/openfasttrace-maven-plugin
[13]: https://www.eclipse.org/legal/epl-2.0/
[31]: http://www.eclipse.org/legal/epl-v10.html
[40]: http://zlika.github.io/reproducible-build-maven-plugin
[23]: https://www.gnu.org/licenses/gpl-3.0.html
[46]: http://maven.apache.org/plugins/maven-jar-plugin/
[11]: https://www.apache.org/licenses/LICENSE-2.0.txt
[28]: https://maven.apache.org/enforcer/maven-enforcer-plugin/
[5]: https://github.com/mockito/mockito/blob/release/3.x/LICENSE
[1]: https://www.eclipse.org/legal/epl-v20.html
[3]: http://www.opensource.org/licenses/bsd-license.php
[48]: http://maven.apache.org/plugins/maven-install-plugin/
[0]: https://junit.org/junit5/
[24]: https://sonatype.github.io/ossindex-maven/maven-plugin/
[8]: http://www.jqno.nl/equalsverifier
[16]: https://maven.apache.org/plugins/maven-source-plugin/
[36]: http://maven.apache.org/plugins/maven-deploy-plugin/
[50]: http://maven.apache.org/plugins/maven-site-plugin/
[44]: http://maven.apache.org/plugins/maven-resources-plugin/
[18]: https://maven.apache.org/plugins/maven-javadoc-plugin/
[38]: https://github.com/exasol/error-code-crawler-maven-plugin
11 changes: 11 additions & 0 deletions doc/changes/changes_4.4.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,17 @@ Code Name:
## Documentation

* #38: Added a GitHub action to deploy JavaDocs.
* #111: Added links to the API documentation.

## Dependency Updates

### Test Dependency Updates

* Updated `nl.jqno.equalsverifier:equalsverifier:3.5.5` to `3.6`
* Updated `org.mockito:mockito-core:3.8.0` to `3.9.0`
* Updated `org.mockito:mockito-junit-jupiter:3.8.0` to `3.9.0`

### Plugin Dependency Updates

* Updated `com.exasol:project-keeper-maven-plugin:0.5.0` to `0.7.0`
* Added `io.github.zlika:reproducible-build-maven-plugin:0.13`
4 changes: 3 additions & 1 deletion doc/user_guide/statements/create_table.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,4 +62,6 @@ point to defining a CREATE TABLE SQL statement.
createTable.accept(renderer);
String renderedString = renderer.render();
```
```
Please check [API documentation](https://exasol.github.io/sql-statement-builder/com/exasol/sql/ddl/create/CreateTable.html) for more details.
Loading

0 comments on commit b5ae2cd

Please sign in to comment.