Skip: Docs/deployment docs (merge commit)

Merge branch 'docs/deployment-docs' into 'main'
* add deployment docs

* add changelog

See merge request https://gitlab.ci.csc.fi/sds-dev/crypt4gh-gui/-/merge_requests/28

Approved-by: Teemu Kataja <tekataja@csc.fi>
Co-authored-by: Stefan Negru <stefan@blankdots.com>
Merged by Teemu Kataja <tekataja@csc.fi>

CHANGELOG.md

@@ -0,0 +1,173 @@
+# Changelog
+Format updates according to [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+Update version according to [Calendar Versioning](https://calver.org/).
+
+Always place latest update on top.
+
+## [Unreleased]
+
+## [2024.02.2] - 2024-02-06
+
+### Removed
+- remove leading zero from calver in windows build only (merge commit)
+- remove leading zero only from first instance, which is always the month number
+
+## [2024.02.1] - 2024-02-06
+
+### Changed
+- make it possible to trigger buils using calver (merge commit)
+- make it possible to trigger buils using calver
+
+## [2024.02.0] - 2024-02-06
+
+### Added
+- add tox
+- codeql track main
+
+### Removed
+- remove extra spaces
+
+### Changed
+- Update .gitlab-ci.yml file (merge commit)
+
+## [v1.4.0] - 2023-07-04
+
+### Added
+- Add workflows for windows executable versioning and signing
+
+### Changed
+- Refactor version parsing
+
+## [v1.3.3] - 2023-05-08
+
+### Changed
+- better fix for noconsole bug
+
+### Fixed
+- Fix windows noconsole bug
+
+
+## [v1.3.2] - 2023-04-27
+
+### Fixed
+- Fix windows noconsole bug
+
+## [v1.3.1] - 2023-04-20
+
+### Changed
+- compromise fix for windows build: display cmd behind gui app
+
+
+## [v1.3.0] - 2023-02-22
+
+### Fixed
+- fix misses in syntax linting
+
+### Changed
+- switch to python 3.10
+
+## [v1.3.0-rc0] - 2023-02-22
+
+### Fixed
+- address mypy issues
+- fix misses in syntax linting
+- fix deprecated syntax for set-output
+
+### Changed
+- switch to python 3.10
+
+## [v1.2.1] - 2022-09-05
+
+### Changed
+- Bump crypt4gh from 1.5 to 1.6
+- Bump pynacl from 1.4.0 to 1.5.0
+- reformatted file for length
+
+### Fixed
+- fix mypy issues
+- fix any window type
+
+## [v1.2.0] - 2022-01-05
+
+### Added
+- add missing brackets to workflow file
+
+### Changed
+- correct artifact name
+- fail_on_unmatched_files to true
+- update error message
+- update readme
+- update activity log instructions
+- update deprecated release action
+
+### Removed
+- remove deprecated key from workflow
+
+## [v1.1.0] - 2021-07-15
+
+### Added
+- add requirements to release
+
+### Changed
+- better error description
+- catch error on key password & overwritting existing key
+- update crypt4gh support
+
+### Fixed
+- fix release install
+- fix styles and add tox checks
+
+## [sds-1.0.0] - 2021-06-17
+## [sds-v0.1.0] - 2021-06-17
+## [sds-v1.0.0] - 2021-06-17
+
+### Added
+- add setup.py
+- add sds release file
+- add github action for release on tag
+
+### Changed
+- confirm password on generation by typing it twice
+- Create crypt4SDS_gui.py
+- Create dependabot.yml
+- Create codeql-analysis.yml
+- try to make build work and update gh actions
+
+### Fixed
+- fix crypt4gh
+- fix name for installer source
+
+## [feature/icon] - 2020-04-22
+## [master] - 2020-04-22
+## 1.0.0 - 2020-04-22
+
+### Added
+- add os-dependent layout config
+- add license
+
+### Changed
+- display module errors in activity log 
+- edit file label
+- make sender public key optional for file decryption
+- rename window title
+
+### Update
+- update readme
+[Unreleased]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/2024.02.2...HEAD
+[2024.02.2]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/2024.02.1...2024.02.2
+[2024.02.1]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/2024.02.0...2024.02.1
+[2024.02.0]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/v1.4.0...2024.02.0
+[v1.4.0]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/v1.3.3...v1.4.0
+[v1.3.3]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/v1.3.2...v1.3.3
+[v1.3.2]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/v1.3.1...v1.3.2
+[v1.3.1]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/v1.3.0...v1.3.1
+[v1.3.0]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/v1.3.0-rc0...v1.3.0
+[v1.3.0-rc0]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/v1.2.1...v1.3.0-rc0
+[v1.2.1]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/v1.2.0...v1.2.1
+[v1.2.0]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/v1.1.0...v1.2.0
+[v1.1.0]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/sds-1.0.0...v1.1.0
+[sds-1.0.0]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/sds-v0.1.0...sds-1.0.0
+[sds-v0.1.0]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/sds-v1.0.0...sds-v0.1.0
+[sds-v1.0.0]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/feature/icon...sds-v1.0.0
+[feature/icon]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/master...feature/icon
+[master]: https://gitlab.ci.csc.fi:10022/sds-dev/crypt4gh-gui/compare/1.0.0...master

DEPLOYMENT.md

@@ -0,0 +1,16 @@
+# Usage of Crypt4gh GUI
+
+Crypt4gh GUI is a wrapper of the [crypt4gh python library](https://github.com/EGA-archive/crypt4gh), and of aims to provide a Graphical User Interface for Linux, Windows and MacOS, however the focus is on Linux and Windows.
+
+## Prerequisites
+
+For building Python is recommended.
+
+Select the release from https://github.com/CSCfi/crypt4gh-gui/releases
+
+## Installation
+
+1. Download ZIP archive from selected release. Archives are named as `crypt4gh-gui-<python-version>-<operating-system>-<architecture>.zip`.
+Where `operating-system` is one of `linux`, `windows` or `macos` and `architecture` is fixed to `amd64`. For example for linux: `crypt4gh-gui-python3.10-linux-amd64.zip`
+
+2. Unzip archive and the binary/executable should be available for use.

README.md

@@ -20,7 +20,7 @@ For more advanced features, please refer to the [CLI](https://github.com/EGA-arc
 ## Installation
 
 The GUI requires a python installation with [tkinter](https://docs.python.org/3/library/tkinter.html)
-```
+```bash
 git clone https://github.com/CSCfi/crypt4gh-gui
 pip install -r requirements.txt
 
@@ -34,7 +34,7 @@ Standalone executable build requires:
 
 The GUI can be built into a standalone executable and distributed to machines that don't have python installed. After running the `pyinstaller` command, the standalone executable file can be found in the `dist/` directory.
 
-```
+```bash
 pip install pyinstaller
 
 pyinstaller --onefile crypt4gh_gui.py
@@ -43,12 +43,12 @@ pyinstaller --onefile crypt4gh_gui.py
 This has been tested on Linux and Windows.
 
 To run the executable on Linux:
-```
+```bash
 ./crypt4gh_gui
 ```
 
 To run the executable on Windows:
 - Double click on `crypt4gh_gui.exe` or run the following in `cmd`:
-```
+```bash
 crypt4gh_gui.exe
 ```