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.

Sign up for GitHub

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

Feature: backwards compatibility #86

Merged
merged 8 commits into from
Jun 28, 2024
Merged

Feature: backwards compatibility #86

Changes from 1 commit
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
bdb5f10
add v2 backwards compatibility shell scripts for automation purposes
consolethinks Jun 26, 2024
577ee18
update readme to describe backwards compatibilty solution
consolethinks Jun 26, 2024
f7c0b59
remove outdated comments
consolethinks Jun 26, 2024
7347b75
add warning message to bw compat scripts
consolethinks Jun 26, 2024
47f63f5
add v2 scripts as separate archive in releases
consolethinks Jun 27, 2024
66e52e7
update README.md with v3 changes and v2 back compat information
consolethinks Jun 27, 2024
b94f451
better README comprehensibility
consolethinks Jun 27, 2024
060a35d
small README corrections
consolethinks Jun 27, 2024
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: 13 additions & 1 deletion README.md
View file
Open in desktop
minottic marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -25,11 +25,23 @@ Tools are compiled for the following architectures:

These can be cross-compiled from any system.

### V3 Changes
The separate executables (like `datasetIngestor`, `datasetRetriever`...) were combined into one `scicat-cli` executable, with each executable's features available as commands given as the first parameter to this executable.

These commands bare the same names as the former executables. For example, if you called `./datasetIngestor [flags]` before, now it's `./scicat-cli datasetIngestor [flags]`.

Furthermore, the use of single hyphen, multi-letter flags is now discontinued (as it does not follow convention).
minottic marked this conversation as resolved.
Show resolved Hide resolved

### Backwards compatibility with v2
A set of shell scripts are included with the Linux and Mac versions of releases in order to maintain compatibility with preexisting automation scripts.
As these are written in BASH, Windows is not supported unless WSL2 is used.

The scripts and the scicat-cli executable should be kept in the same folder for them to work.
Useful informations:
- The scripts can be found on the [Releases](https://github.com/paulscherrerinstitute/scicat-cli/releases) page, under scicat-cli_V2Scripts-[VERSION].tar.gz.

- The scripts and the scicat-cli executable **must** be kept in the **same folder** for them to work.

- The scripts will still accept single hyphen flags as well.

## Deployment

Expand Down