Skip to content

Commit 37be16a

Browse files
committed
Bumps version
1 parent 8f18572 commit 37be16a

File tree

2 files changed

+51
-4
lines changed

2 files changed

+51
-4
lines changed

CHANGELOG.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# CHANGELOG
2+
3+
All notable changes to the "**cookie-github**" will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
6+
7+
---
8+
9+
## [Unreleased]
10+
11+
### TODO
12+
13+
-
14+
15+
### Added
16+
17+
-
18+
19+
### Changed
20+
21+
-
22+
23+
### Fixed
24+
25+
-
26+
27+
## [**1.0.0**] - 2023-03-12
28+
29+
### Added
30+
31+
- Cookiecutter templates for .github folder.
32+
- Cookiecutter action for CI Unit testing in C++ (CMake, Catch2 based).
33+
- Basic Documentation.
34+
35+
### Changed
36+
37+
-
38+
39+
### Fixed
40+
41+
-

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,17 @@ This repository can be used for adding Github Actions and templates to an existi
44

55
## Version
66

7-
Current version is 0.1.0 and was set according to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7+
Current version is 1.0.0 and was set according to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
88

99
Project's version should be updated, when applicable:
1010

1111
- In this very file.
12+
- In the changelog.
1213

1314
## Usage
1415

15-
In order to start a new project, install [Cookiecutter](https://cookiecutter.readthedocs.io/en/latest/) and run the following command:
16+
In order to start a new project, install [Cookiecutter](https://cookiecutter.readthedocs.io/en/latest/)
17+
and run the following command:
1618

1719
```bash
1820
$ cookiecutter https://github.com/ferreteleco/cookie-github.git
@@ -30,8 +32,8 @@ again. In order to do so, simply specify template name as argument for cookiecut
3032
$ cookiecutter cookie-github
3133
```
3234

33-
NOTE: alternatively, you can use [Cookieninja](https://github.com/cookieninja-generator/cookieninja), a forked and more updated version of Cookiecutter with
34-
backward compatibility.
35+
NOTE: alternatively, you can use [Cookieninja](https://github.com/cookieninja-generator/cookieninja),
36+
forked and more updated version of Cookiecutter with backward compatibility.
3537

3638
## Variables
3739

@@ -42,6 +44,10 @@ you will be prompted to fill in the following values:
4244
folder.
4345
- **add_PR_template:** this flags controls wether or not to add a PR template in the generated
4446
folder.
47+
- **add_ci_action_unit_tests_runner:** this variable controls whether or not to create an action to
48+
run unit tests in the repository. The available options are:
49+
- none (no action created).
50+
- cpp, which creates an action for Catch2 based unit tests, built using CMake.
4551

4652
## Contributing
4753

0 commit comments

Comments
 (0)