erik/sdkman-for-fish
erik/sdkman-for-fish
1
0
Fork 0
mirror of https://github.com/ethauvin/sdkman-for-fish.git synced 2025-04-24 21:07:11 -07:00
Code Issues Projects Releases Packages Wiki Activity Actions

chore(docs): Release 2.1.0

Browse source
This commit is contained in:
Raphael Reitzig 2024-04-03 23:58:08 +02:00
parent 5c886dcd1c
commit fefab41aac
2 changed files with 13 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

2
CHANGELOG.md
View file

@ -5,7 +5,7 @@ All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), and
this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased] ## [2.1.0] - 2024-04-03
### Added ### Added

37
README.md
View file

@ -9,18 +9,18 @@
Makes command `sdk` from [SDKMAN!] usable from [fish], including auto-completion. Makes command `sdk` from [SDKMAN!] usable from [fish], including auto-completion.
Also adds binaries from installed SDKs to the PATH. Also adds binaries from installed SDKs to the PATH.
Version 2.0.0 has been tested with Version 2.1.0 has been tested with
- fish 3.6.1, and - fish 3.7 and
- SDKMAN! 5.18.2, on - SDKMAN! 5.18.2 on
- Ubuntu 22.04 LTS and macOS 12.6 - Ubuntu 22.04 LTS and macOS 14.4
## Install ## Install
With [fisher] (install separately): With [fisher] (install separately):
``` ```
fisher install reitzig/sdkman-for-fish@v2.0.0 fisher install reitzig/sdkman-for-fish@v2.1.0
``` ```
_Note:_ _Note:_
@ -39,27 +39,25 @@ _Note:_
for example, you can use `.config/fish/conf.d/config_sdk.fish`. for example, you can use `.config/fish/conf.d/config_sdk.fish`.
- If _both_ are set, `__sdkman_custom_dir` is used. - If _both_ are set, `__sdkman_custom_dir` is used.
## Usage ## Usage
It's all in the background; you should be able to run `sdk` and binaries installed It's all in the background; you should be able to run `sdk` and
with `sdk` as you would expect. binaries installed with `sdk` as you would expect.
## Contribute ## Contribute
When you make changes, When you propose changes,
please run the tests at least on one platform before creating a pull request. please run the tests at least on one platform before creating a pull request.
As the tests may mess up your own setup As the tests may mess up your machine
-- you have been warned! -- -- you have been warned! --
the recommended way is to run the tests in a Docker container: the recommended way is to run them in a Docker container:
```fish ```fish
docker build -t sdkman-for-fish-tests -f test/Dockerfile . docker build -t sdkman-for-fish-tests -f test/Dockerfile .
docker run --rm -it sdkman-for-fish-tests docker run --rm -it sdkman-for-fish-tests
``` ```
A run configuration for Jetbrains IDEs is included. A run configuration for Jetbrains IDEs is included.
It is a also possible to run individual features, for instance: It is a also possible to run individual features, for instance:
@ -68,17 +66,6 @@ It is a also possible to run individual features, for instance:
docker run --rm sdkman-for-fish-tests features/completions.feature docker run --rm sdkman-for-fish-tests features/completions.feature
``` ```
As a corollary, this is the fastest way to run all tests
(if you do not care about the report):
```fish
for f in features/*.feature
docker run --rm sdkman-for-fish-tests "$f" &
done
wait
```
## Acknowledgements ## Acknowledgements
* Completion originally by [Ted Wise](https://github.com/ctwise); see his * Completion originally by [Ted Wise](https://github.com/ctwise); see his