Skip to content

Commit

Permalink
Merge pull request #6 from auditum-mpa/development
Browse files Browse the repository at this point in the history
Updated build.xml and README.md
  • Loading branch information
myxcel authored Nov 1, 2022
2 parents 0a14891 + cfbf0ba commit 8739111
Show file tree
Hide file tree
Showing 5 changed files with 167 additions and 35 deletions.
26 changes: 0 additions & 26 deletions .github/workflows/ant.yml

This file was deleted.

43 changes: 43 additions & 0 deletions .github/workflows/static.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Simple workflow for deploying static content to GitHub Pages
name: Deploy static content to Pages

on:
# Runs on pushes targeting the default branch
push:
branches: ["master"]

# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write

# Allow one concurrent deployment
concurrency:
group: "pages"
cancel-in-progress: true

jobs:
# Single deploy job since we're just deploying
deploy:
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
# Upload entire repository
path: '.'
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1

1 change: 0 additions & 1 deletion .gitignore
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
# IDE
.idea/
.settings/

# Keys and credentials
.songe.key*
Expand Down
32 changes: 24 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
<img src="https://espritlibredev.keybase.pub/lunasql-figlet.png" alt="LunaSQL Logo" />
<img src="lunasql-figlet.png" alt="LunaSQL Logo" />

*LunaSQL* - a fair SQL shell client
===================================
Expand All @@ -9,18 +9,20 @@
<ol>
<li><a href="#about-the-project">About The Project</a></li>
<li><a href="#features-and-motivation">Features and motivation</a></li>
<li><a href="#checking-integrity">Checking integrity</a></li>
<li><a href="#getting-started">Getting started</a></li>
<li><a href="#how-to-contribute">How to contribute</a></li>
<li><a href="#external-libraries">External libraries</a></li>
<li><a href="#checking-integrity">Checking integrity</a></li>
<li><a href="#license">License</a></li>
</ol>
</details><br />

[![Checks](https://github.com/auditum/lunasql/actions/workflows/ant.yml/badge.svg)](https://github.com/auditum/lunasql/actions/workflows/ant.yml) -
[![Java CI](https://github.com/auditum-mpa/lunasql/actions/workflows/ant.yml/badge.svg)](https://github.com/auditum-mpa/lunasql/actions/workflows/ant.yml) -
[![Discuss](https://img.shields.io/badge/version-4.9.1.3-green)](https://github.com/auditum-mpa/lunasql/releases/tag/4.9.3.0)
[![Releases](https://img.shields.io/github/downloads/auditum-mpa/lunasql/total.svg)]() -
[![Discuss](https://img.shields.io/badge/discuss-here-magenta)](https://github.com/auditum/lunasql/discussions)
[![Wiki](https://img.shields.io/badge/consult-wiki-blue)](https://github.com/auditum/lunasql/wiki)
[![Issue](https://img.shields.io/badge/report-issue-orange)](https://github.com/auditum/lunasql/issues)
[![Releases](https://img.shields.io/github/downloads/auditum-mpa/lunasql/total.svg)](https://github.com/auditum-mpa/lunasql/releases/latest) -
[![Discuss](https://img.shields.io/badge/discuss-here-magenta)](https://github.com/auditum-mpa/lunasql/discussions)
[![Wiki](https://img.shields.io/badge/consult-wiki-blue)](https://github.com/auditum-mpa/lunasql/wiki)
[![Issue](https://img.shields.io/badge/report-issue-orange)](https://github.com/auditum-mpa/lunasql/issues)

## About the project

Expand Down Expand Up @@ -50,6 +52,20 @@ LunaSQL is released as a jar file, which can be run using [H2 Database driver](h
java lunasql.Main --type=H2DB --name=path/to/base/MyDB --user=sa --password="" --console
```

To build the distribution, just run the [ant](https://ant.apache.org) task (you may have to adapt the `path id="classpath"` entry):

```
ant dist
```

## How to contribute

Any help will be greatly appreciated! You can contribute by using the application and testing it, [reporting new issues](https://github.com/auditum-mpa/lunasql/issues). You can also try to work on [good first issues](https://github.com/auditum-mpa/lunasql/contribute). Don't forget that the [Discussions page](https://github.com/auditum-mpa/lunasql/discussions) warmly welcomes you to say hello or discuss about new ideas, questions...

## External libraries

See the [src/lunasql/doc/libraries.txt](https://github.com/auditum-mpa/lunasql/blob/master/src/lunasql/doc/libraries.txt). Thank you to all libraries contributors for your good job!

## Checking integrity

First, commits are signed with PGP key fingerprint `6F9F 349C D9DB 0B1A A0EC B6DE 2EA0 CCE6 2860 3945` and are automatically verified by GitHub. Additionally, LunaSQL release library `lunasql.x.x.x.jar` file is signed by [Keybase PGP key](https://keybase.io/espritlibredev/key.asc) (fingerprint `AA77 7903 6281 D0E9 209B E8B9 2627 39EB A36C EB3E`).
Expand All @@ -71,7 +87,7 @@ curl https://keybase.io/espritlibredev/key.asc | gpg --import && \

LunaSQL is distributed under the CeCILL License. See the [french](http://cecill.info/licences/Licence_CeCILL_V2.1-fr.html) or [english](http://cecill.info/licences/Licence_CeCILL_V2.1-en.html) versions for further details.

If you like Songe, please pay me a :coffee: coffee ([Stellar](https://www.stellar.org/) _espritlibredev*keybase.io_)
If you like LunaSQL, please pay me a :coffee: coffee ([Stellar](https://www.stellar.org/) _espritlibredev*keybase.io_)

Enjoy!

100 changes: 100 additions & 0 deletions build.xml
Original file line number Diff line number Diff line change
@@ -0,0 +1,100 @@
<!--
Description :
LunaSQL Ant build file https://ant.apache.org
Création : 31/10/2022
Édition : 31/10/2022
Version : 1.0
-->

<project name="lunasql" default="build" basedir=".">
<description>
Another dead naive but positive and fun Java JDBC SQL shell client
</description>

<property name="src" location="src"/>
<property name="build" location="build"/>
<property name="dist" location="release"/>
<property name="docs" location="docs"/>
<property name="version" value="4.9.3"/>
<property name="main" value="lunasql.Main"/>

<path id="classpath">
<fileset dir="../../lib">
<include name="h2-1.4.200.jar" />
<include name="jansi-1.11.jar" />
<include name="javamail-1.5.jar" />
<include name="jsyntaxpane-0.9.5.jar" />
<include name="jsqlparser.jar" />
</fileset>
</path>

<target name="init">
<tstamp/>
</target>

<target name="build" depends="init" description="compile the source">
<mkdir dir="${build}"/>
<javac srcdir="${src}" destdir="${build}"
optimize="on" debug="on" deprecation="on" includeantruntime="false">
<classpath refid="classpath"/>
</javac>
<copy todir="${build}/lunasql/doc">
<fileset dir="${src}/lunasql/doc">
<include name="**/*"/>
</fileset>
</copy>
<copy todir="${build}/lunasql/http">
<fileset dir="${src}/lunasql/http">
<include name="**/*.txt"/>
</fileset>
</copy>
<copy todir="${build}/lunasql/http/res">
<fileset dir="${src}/lunasql/http/res">
<include name="**/*"/>
</fileset>
</copy>
<copy todir="${build}/lunasql/misc">
<fileset dir="${src}/lunasql/misc">
<include name="**/*.sql"/>
<include name="**/*.js"/>
</fileset>
</copy>
</target>

<target name="dist" depends="build" description="generate the distribution">
<mkdir dir="${dist}"/>
<mkdir dir="${dist}/lib"/>
<jar jarfile="${dist}/lib/lunasql-${version}.jar" basedir="${build}">
<manifest>
<attribute name="Manifest-Version" value="1.0"/>
<attribute name="Ant-Version" value="Apache Ant 1.8.3"/>
<attribute name="Main-Class" value="${main}"/>
<attribute name="Class-Path" value="${main}"/>
</manifest>
</jar>
</target>

<target name="run" depends="dist">
<java jar="${dist}/lib/lunasql-${version}.jar" fork="true"/>
</target>

<target name="javadoc" depends="build" description="Generate documentation">
<mkdir dir="${docs}"/>
<javadoc destdir="${docs}/javadoc"
link="http://download.oracle.com/javase/8/docs/api/"
sourcepath="${src}"
doctitle="LunaSQL ${version}"
windowtitle="LunaSQL ${version}">
<classpath refid="classpath"/>
</javadoc>
</target>

<target name="clean" description="clean up">
<delete dir="${build}"/>
<delete dir="${dist}"/>
<delete dir="${docs}"/>
</target>

</project>

0 comments on commit 8739111

Please sign in to comment.