Skip to content

Commit

Permalink
1.8.0
Browse files Browse the repository at this point in the history
  • Loading branch information
Josee9988 committed Jul 9, 2021
1 parent e15eedb commit af287f1
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 3 deletions.
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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. 🚀
Expand Down Expand Up @@ -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**
Expand Down

0 comments on commit af287f1

Please sign in to comment.