From e201f6e4399da676090745f2b0c198b18b21e7e1 Mon Sep 17 00:00:00 2001 From: vikin91 Date: Sat, 4 May 2019 21:12:27 +0200 Subject: [PATCH] Release 0.5.4. Update Readme and Changelog --- CHANGELOG.md | 2 +- README.md | 83 +++++++++++++++++++++++++++++++++++++++------------- 2 files changed, 63 insertions(+), 22 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 19fa631..0204465 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,6 @@ ### Changelog ### -#### v0.5.4 - ??.05.2019 +#### v0.5.4 - 04.05.2019 * Added: * Support for Mojolicious `>7.55` by changing route placeholders from `()` to `<>` (#38) diff --git a/README.md b/README.md index f3c1812..d7d0141 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ # README # -BibSpace is an Online Bibtex Publications Management Software for Authors and Research Groups. Read about its features on the [BibSpace @ the Error Blog](https://blog.hex64.com/bibspace-online-bibtex-publications-management-software-for-authors-and-research-groups/). +BibSpace is an Online Bibtex Publications Management Software for Authors and Research Groups. +Read about its features at the _Error Blog_ under: [BibSpace @ the Error Blog](https://blog.hex64.com/bibspace-online-bibtex-publications-management-software-for-authors-and-research-groups/). ## Build status ## @@ -29,7 +30,7 @@ docker-compose build docker-compose -f docker-compose.yml up -d ``` -That's it! Point you browser to http://localhost:8083/ to open BibSpace. +That's it! Point you browser to [http://localhost:8083/](http://localhost:8083/) to open BibSpace. You may stop the container with @@ -41,18 +42,56 @@ The MySQL data is stored in `db_data`, whereas preferences and stats in `json_da ## Updating -Make sure to backup your data (regular backup + copy all `json` files) before updating. - -### From Version <=0.5.2 to 0.6.x - -1) *Important*: Update to version 0.5.3 first - this will enable JSON backups. -2) Backup your data to JSON format and make sure that data can be restored correctly. -3) Replace code with version 0.6.0 and restore data from the JSON backup. - -### From Version 0.5.0 to >0.5.0 - -1) Update normally by replacing the code with newer version -2) Execute the following commands: +### General update instructions + +#### Any update of native installation (no Docker) + +1. Make backup +2. Replace code with the code from a newer version: + ``` + git clone --branch https://github.com/vikin91/BibSpace.git + ``` + Whereas `` equals the name of a branch or release tag, for example: `v0.5.4`. +3. (Optional) Restore backup if any data got lost. + +#### Any update of Docker installation + +1. Make backup +2. Stop Docker containers `docker-compose down` +3. Download `docker-compose.yml` file from Github +4. Change the image version of BibSpace in `docker-compose.yml` + Locate the following part and remove the `build` part. + ``` + bibspace: + build: + context: . + dockerfile: Dockerfile + depends_on: + - db + ``` + And add the `image` definition with respective version. + For version `0.6.0` this will look as follows: + ``` + bibspace: + image: bibspace:0.6.0 + depends_on: + - db + ``` +4. Run with `docker-compose up -d` +5. (Optional) Restore backup if any data got lost. + +### Update instructions for particular versions + +#### From Version `<=0.5.2` to `0.6.x` + +1. *Important*: Update to version `0.5.3` or `0.5.4` first to enable JSON backups. +2. Backup your data to the *JSON format* and make sure that data can be restored correctly. +3. Replace code with version `0.6.0` and restore data from the JSON backup. + +#### From Version `0.5.0` to `>0.5.0` + +1. Update normally by replacing the code with newer version +2. Execute the following commands: ``` mkdir -p json_data @@ -63,14 +102,16 @@ mv *.json json_data/ I currently work on BibSpace to improve several things. I ship code in coding sessions that happen rather rarely - once, twice per year. -In each session I implement things according to the following priority list: -- [ ] Fix bugs from open issues -- [ ] Increase test coverage -- [ ] Implement features +In each session, I implement things according to the following priority list: + +1. Fix bugs from open issues +2. Increase test coverage (until >90% is reached) +3. Redesign/refactor bad smells in code from the past +4. Implement features Moreover, I keep redesigning BibSpace to increase the quality of code. Remember that this was a `perl` and `Mojolicious` sandbox, so not all parts were written properly in the past. The following elements will be improved as the work progresses: -- Fixing the ugliest backend API and refactoring it to adhere to REST API best practices -- Separate backend and frontend code into separate code modules or even projects -- Applying modern frontend framework +- Fix the ugliest backend API and refactoring it to adhere to REST API best practices +- Separate the backend code and the frontend code into modules or even projects +- Apply modern frontend framework