Skip to content

Commit

Permalink
#236: prepare release 1.0.0 (#241)
Browse files Browse the repository at this point in the history
* #236: Prepated release 1.0.0
  • Loading branch information
tomuben authored Sep 4, 2024
1 parent b30b1fa commit 0836710
Show file tree
Hide file tree
Showing 11 changed files with 47 additions and 162 deletions.
12 changes: 0 additions & 12 deletions .github/workflows/shellcheck.yaml

This file was deleted.

1 change: 1 addition & 0 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,4 @@ repos:
- id: check-yaml
- id: end-of-file-fixer
- id: trailing-whitespace
- id: no-commit-to-branch
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,15 +99,15 @@ Create the language container and export it to the local file system
exaslct export --flavor-path=flavors/<flavor-name> --export-path <export-path>
```

or upload it directly into the BucketFS (currently http only, https follows soon)
or deploy it directly to the BucketFS (both http and https are supported)

```bash
exaslct upload --flavor-path=flavors/<flavor-name> --database-host <hostname-or-ip> --bucketfs-port <port> \
--bucketfs-username w --bucketfs-password <password> --bucketfs-name <bucketfs-name> \
--bucket-name <bucket-name> --path-in-bucket <path/in/bucket>
exaslct deploy --flavor-path=flavors/<flavor-name> --bucketfs-host <hostname-or-ip> --bucketfs-port <port> \
--bucketfs-user w --bucketfs-password <password> --bucketfs-name <bucketfs-name> \
--bucket <bucket-name> --path-in-bucket <path/in/bucket> --bucketfs-use-https 1
```

Once it is successfully uploaded, it will print the ALTER SESSION statement
Once it is successfully deployed, it will print the ALTER SESSION statement
that can be used to activate the script language container in the database.

#### How to activate a script language container in the database
Expand Down
10 changes: 7 additions & 3 deletions doc/changes/changes_1.0.0.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,14 @@
# Script-Languages-Container-Tool 1.0.0, released t.b.d.
# Script-Languages-Container-Tool 1.0.0, released 2024-09-04

Code name: t.b.d.
Code name: Major refactoring and new deployment API

## Summary

t.b.d.
This release changed the directory structure and aimed to separate the public and internal modules.
Also, the project now uses the `exasol-toolbox` to execute code quality CI jobs. There are new functions which
simplify the deployments of Script Language Containers on BucketFS.
The new API improves the generation of the Language Activation commands and provides new objects which contain
more detailed information about the installed Script Language Containers in BucketFS.

## Features

Expand Down
14 changes: 14 additions & 0 deletions doc/developer_guide/developer_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,20 @@

EXASLCT is the build tool for the script language container. This document is about the inner working of EXASLCT.

## Preparations

This project uses [pre-commit](https://pre-commit.com/) to run certain Githooks for validation. You don't have to install `pre-commit` as it will be installed with the `exasol-toolbox`.
You can activate the Githooks simply by running:
```commandline
pre-commit install
```

However, if you don't want to run all the checks during every commit, you can use:
```
poetry run nox -s check
```
to run all available checks on the project.

## About the Script Language Containers

The Script Language Containers are getting build from several Dockerfiles which depend on each other. These Dockerfiles need to install all necessary dependencies for the [script client](https://github.com/exasol/script-languages/tree/master/exaudfclient/base), compile the script client and install all necessary dependencies for the flavor and the customizations of the user.
Expand Down
50 changes: 0 additions & 50 deletions githooks/install.sh

This file was deleted.

10 changes: 0 additions & 10 deletions githooks/pre-commit

This file was deleted.

43 changes: 0 additions & 43 deletions githooks/pre-push

This file was deleted.

8 changes: 0 additions & 8 deletions githooks/prohibit_commit_to_main.sh

This file was deleted.

36 changes: 20 additions & 16 deletions poetry.lock

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

15 changes: 0 additions & 15 deletions scripts/build/shellcheck.sh

This file was deleted.

0 comments on commit 0836710

Please sign in to comment.