Skip to content

Commit eb4fecd

Browse files
committed
Hopefully final tweaks to the release process, updated documentation to reflect we got releases.
#2
1 parent 01e2bae commit eb4fecd

File tree

2 files changed

+12
-8
lines changed

2 files changed

+12
-8
lines changed

.github/workflows/release.yaml

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,6 @@ jobs:
2323
with:
2424
repo_token: ${{ secrets.GITHUB_TOKEN }}
2525
file: db2xls-bundle/target/db2xls-bundle-${{ github.event.release.tag_name }}.jar
26-
asset_name: Executable Bundle
26+
asset_name: db2xls-bundle-${{ github.event.release.tag_name }}.jar
2727
tag: ${{ github.ref }}
2828
overwrite: true
29-
body: "An executable JAR, pre-packaged with some JDBC drivers."

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,17 @@ Contents:
1818
Quick Start
1919
===========
2020

21-
Finding or building the tool
22-
----------------------------
21+
Downloading the Bundled Version
22+
-------------------------------
2323

24-
There is currently no fully published version of this tool, but you can find the result of the most recent builds
25-
in the "Artifacts" section of the builds in [Github Actions](https://github.com/peterbecker/xls-utils/actions).
26-
The documentation on running the example assumes you downloaded or checkout out a copy of the source code either way.
24+
You can find the pre-packaged bundles on [the GitHub releases](https://github.com/peterbecker/xls-utils/releases), these
25+
contain the program itself with some common database connectors.
2726

28-
To build the command line tool, you need to build this project first using:
27+
Building from Source
28+
--------------------
29+
30+
To build the tool, get a copy of the source by cloning this repository or downloading a ZIP from the release page. Then
31+
run this command inside the project folder:
2932

3033
```shell script
3134
mvn package
@@ -37,6 +40,8 @@ This requires a [Java Development Kit (JDK) 11 or greater](https://adoptopenjdk.
3740
Running the Example
3841
-------------------
3942

43+
The documentation on running the example assumes you downloaded or checked out a copy of the source code as well.
44+
4045
Once the build has finished, go into `db2xls-bundle/sample` -- this contains a fully functional example with a
4146
script `run.sh` to execute it (it's a single command, if you can't use the script run it directly).
4247

0 commit comments

Comments
 (0)