Skip to content

Commit

Permalink
chore(docs): Release 2.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
reitzig committed Apr 3, 2024
1 parent 5c886dc commit fefab41
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 26 deletions.
2 changes: 1 addition & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [Unreleased]
## [2.1.0] - 2024-04-03

### Added

Expand Down
37 changes: 12 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,18 @@
Makes command `sdk` from [SDKMAN!] usable from [fish], including auto-completion.
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
- SDKMAN! 5.18.2, on
- Ubuntu 22.04 LTS and macOS 12.6
- fish 3.7 and
- SDKMAN! 5.18.2 on
- Ubuntu 22.04 LTS and macOS 14.4

## Install

With [fisher] (install separately):

```
fisher install reitzig/sdkman-for-fish@v2.0.0
fisher install reitzig/sdkman-for-fish@v2.1.0
```

_Note:_
Expand All @@ -39,27 +39,25 @@ _Note:_
for example, you can use `.config/fish/conf.d/config_sdk.fish`.
- If _both_ are set, `__sdkman_custom_dir` is used.


## Usage

It's all in the background; you should be able to run `sdk` and binaries installed
with `sdk` as you would expect.

It's all in the background; you should be able to run `sdk` and
binaries installed with `sdk` as you would expect.

## Contribute

When you make changes,
When you propose changes,
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! --
the recommended way is to run the tests in a Docker container:
the recommended way is to run them in a Docker container:

```fish
docker build -t sdkman-for-fish-tests -f test/Dockerfile .
docker run --rm -it sdkman-for-fish-tests
```

A run configuration for Jetbrains IDEs is included.

It is a also possible to run individual features, for instance:
Expand All @@ -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
```

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

* Completion originally by [Ted Wise](https://github.com/ctwise); see his
Expand Down

0 comments on commit fefab41

Please sign in to comment.