Skip to content

Commit

Permalink
release: v0.17.1
Browse files Browse the repository at this point in the history
  • Loading branch information
BrunoBonacci committed Jan 14, 2021
1 parent bd8f7e4 commit ff754c8
Show file tree
Hide file tree
Showing 5 changed files with 24 additions and 18 deletions.
10 changes: 8 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,19 @@
# Changelog

## Release: v0.17.0 (2021-01-03)
## Release: v0.17.1 (2021-01-14)

* Transition version in preparation for `v0.20.0`. **Use this
* Transition version in preparation for `v0.21.0`. **Use this
version if you have an existing installation of 1Config,
jump to the new version if you are starting on a new account.**
* Migration tool to migrate database to new format
* `SET` command saves in both versions

## Release: v0.17.0 (2021-01-03) *(use: `v0.17.1`)*

* Transition version in preparation for `v0.2x.0`.
* Migration tool to migrate database to new format
* `SET` command saves in both versions

## Release: v0.16.4 (2020-04-04)

* Added AOT compiled library Jar
Expand Down
24 changes: 12 additions & 12 deletions doc/quick-start.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,30 +2,30 @@

Quick start guide to install and use 1Config.

**ATTENTION: The version v0.17.0 is a transition version between the
old format v0.16.4 and the new persistence format v0.20.0.** Use this
**ATTENTION: The version v0.17.1 is a transition version between the
old format v0.16.4 and the new persistence format v0.21.0.** Use this
version only if you have an existing installation that you want to
migrate to v0.20.0+. Use v0.16.4 if you happy with your current
migrate to v0.21.0+. Use v0.16.4 if you happy with your current
solution.

This version has a migration task to migrate the database to a new
persistence format. When you `SET` a new configuration entry, the
entry will be written in two different format, the old one and the new
one thus allowing the version v0.20.0 to read it as well.
one thus allowing the version v0.21.0 to read it as well.

```
v0.20.0 GET SET LIST (new format)
v0.21.0 GET SET LIST (new format)
^ |
| v
v0.17.0 GET SET LIST
v0.17.1 GET SET LIST
| | |
v v v
v0.16.4 GET SET LIST (old format)
```


The version v0.20.0 can only `GET` and `SET` entries with the new format,
while v0.17.0 will `GET` and `LIST` work as before, `SET` will write both
The version v0.21.0 can only `GET` and `SET` entries with the new format,
while v0.17.1 will `GET` and `LIST` work as before, `SET` will write both
formats.

For more info see [the migration page](https://cljdoc.org/d/com.brunobonacci/oneconfig/CURRENT/doc/user-guides/migration-procedure)
Expand All @@ -37,8 +37,8 @@ For more info see [the migration page](https://cljdoc.org/d/com.brunobonacci/one

``` bash
mkdir -p ~/bin
wget https://github.com/BrunoBonacci/1config/releases/download/0.17.0/1cfg -O ~/bin/1cfg
wget https://github.com/BrunoBonacci/1config/releases/download/0.17.0/1cfg-ui-beta -O ~/bin/1cfg-ui-beta
wget https://github.com/BrunoBonacci/1config/releases/download/0.17.1/1cfg -O ~/bin/1cfg
wget https://github.com/BrunoBonacci/1config/releases/download/0.17.1/1cfg-ui-beta -O ~/bin/1cfg-ui-beta
chmod +x ~/bin/1cfg
export PATH=~/bin:$PATH
```
Expand All @@ -47,8 +47,8 @@ export PATH=~/bin:$PATH

- Open a terminal window
- Create installation dir `md %userprofile%\1config\bin`
- Download https://github.com/BrunoBonacci/1config/releases/download/0.17.0/1cfg and save it in the above folder
- Download https://github.com/BrunoBonacci/1config/releases/download/0.17.0/1cfg-ui-beta and save it in the above folder
- Download https://github.com/BrunoBonacci/1config/releases/download/0.17.1/1cfg and save it in the above folder
- Download https://github.com/BrunoBonacci/1config/releases/download/0.17.1/1cfg-ui-beta and save it in the above folder
- Rename file into `1cfg.cmd` with `ren %userprofile%\1config\bin\1cfg %userprofile%\1config\bin\1cfg.cmd`
- Rename file into `1cfg-ui-beta.cmd` with `ren %userprofile%\1config\bin\1cfg-ui-beta %userprofile%\1config\bin\1cfg-ui-beta.cmd`
- Add it to the System path:
Expand Down
4 changes: 2 additions & 2 deletions doc/usage-with-clojure.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ In order to use the library add the dependency to your `project.clj`

``` clojure
;; Leiningen project
[com.brunobonacci/oneconfig "0.17.0"]
[com.brunobonacci/oneconfig "0.17.1"]

;; deps.edn format
{:deps { com.brunobonacci/oneconfig {:mvn/version "0.17.0"} }}
{:deps { com.brunobonacci/oneconfig {:mvn/version "0.17.1"} }}
```

Latest version: [![Clojars Project](https://img.shields.io/clojars/v/com.brunobonacci/oneconfig.svg)](https://clojars.org/com.brunobonacci/oneconfig)
Expand Down
2 changes: 1 addition & 1 deletion doc/usage-with-java.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Then add the dependency
<dependency>
<groupId>com.brunobonacci</groupId>
<artifactId>oneconfig</artifactId>
<version>0.17.0</version>
<version>0.17.1</version>
<classifier>aot</classifier>
</dependency>
```
Expand Down
2 changes: 1 addition & 1 deletion ver/1config.version
Original file line number Diff line number Diff line change
@@ -1 +1 @@
0.17.0
0.17.1

0 comments on commit ff754c8

Please sign in to comment.