From af287f1cc6862b9c4d03a47e2b5448b11d889caf Mon Sep 17 00:00:00 2001 From: Josee9988 Date: Fri, 9 Jul 2021 14:54:31 +0200 Subject: [PATCH] 1.8.0 --- CHANGELOG.md | 17 +++++++++++++++++ README.md | 8 +++++--- 2 files changed, 22 insertions(+), 3 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 03f1f20..cf9f4de 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,23 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) --- +## [**1.8.0**] - 2021-07-09 + +### Added + +* Multiple bash unit tests. +* The SETUP_TEMPLATE.sh now takes a 4th argument which is the type of the project. +* Updated the README to add the new tests documentation + +### Fixed + +* Modified a couple of files where the project name was not changed. + +### Changed + +* Modified the SETUP_TEMPLATE.sh to make it available for the tests. +* Improved the .github/SECURITY.md file + ## [**1.7.2**] - 2021-07-08 ### Added diff --git a/README.md b/README.md index 6cd70c9..c88a78d 100644 --- a/README.md +++ b/README.md @@ -39,18 +39,18 @@ for more information or guidance, follow the [Github guide](https://docs.github. 3. **Execute** the `SETUP_TEMPLATE.sh` shell script to **customize** the files with your data. ```bash - bash SETUP_TEMPLATE.sh # additional parameters [Username] [Project-Name] [Email] + bash SETUP_TEMPLATE.sh # additional parameters [Username] [Project-Name] [Email] [Project type] ``` Or you can also do it like this: ```bash - chmod u+x SETUP_TEMPLATE.sh && ./SETUP_TEMPLATE.sh # additional parameters [Username] [Project-Name] [Email] + chmod u+x SETUP_TEMPLATE.sh && ./SETUP_TEMPLATE.sh # additional parameters [Username] [Project-Name] [Email] [Project type] ``` Additionally, watch *[this video](https://asciinema.org/a/404568)* to see **how to execute the script** or use *`bash SETUP_TEMPLATE.sh --help`* to obtain some extra information. - If the automatic detection of the username, project name or email is NOT right, please post an issue, and you can **manually correct** them like: `bash SETUP_TEMPLATE.sh RightUsername RightProjectName RightEmail` being `$1` the new username, `$2` the new project name and `$3` the new email. + If the automatic detection of the username, project name or email is NOT right, please post an issue, and you can **manually correct** them like: `bash SETUP_TEMPLATE.sh RightUsername RightProjectName RightEmail` being `$1` the new username, `$2` the new project name, `$3` the new email and `$4` the project type. 4. **Review** every single file and **customize** it as you like. 5. Build your project. 🚀 @@ -218,6 +218,8 @@ To do so: bash tests/TESTS_RUNNER.sh ``` +*You may need to give execution permission to all the `tests/` files* + --- ## 🍰 **Supporters and donators**