Skip to content

Commit 70f99d5

Browse files
committed
docs(README): #354 update versioning heading in README
1 parent 64fd911 commit 70f99d5

File tree

1 file changed

+37
-8
lines changed

1 file changed

+37
-8
lines changed

README.md

Lines changed: 37 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -552,8 +552,8 @@ In this section we are going to explore [OWASP ZAP](https://www.zaproxy.org/docs
552552
-t [TARGET_REST_API] -g gen.conf -r pentest-report.html
553553
```
554554
555-
| Parameter | Description |
556-
|-----------------|:---------------------------------------- |
555+
| Parameter | Description |
556+
|-----------------|:-----------------------------------------|
557557
| $(pwd) | Directory where report will be generated |
558558
| zap-baseline.py | Zap's python script |
559559
| -t [TARGET_URL] | URL to be Pen Tested |
@@ -1071,12 +1071,41 @@ Listing down some of the exciting features am going to work on and update the Gi
10711071
10721072
### Versioning
10731073
1074-
We use [SemVer](http://semver.org/) for versioning. For the versions
1075-
available, see the
1076-
[tags on this repository](https://github.com/your/project/tags).
1074+
We use [Cocogitto](https://github.com/cocogitto/cocogitto) for releasing [Semantic SemVer](http://semver.org/) versioned GitHub releases in this repository.
10771075
1078-
### License
1076+
Check the [Releases](https://github.com/abhisheksr01/spring-boot-microservice-best-practices/releases) section in repository to know the latest releases.
1077+
1078+
The GitHub releases are automated in the GHA CI based on [Cocogitto's conventional commit types](https://docs.cocogitto.io/guide/commit.html).
1079+
1080+
<details>
1081+
1082+
<summary>Clicks here for details on this repository automated the releases.</summary>
1083+
1084+
#### GHA CI release flow
1085+
1086+
- When a change is committed to the repository with conventional commit type the GHA CI pipeline is triggered
1087+
- The `docker-build-push` job `cog-bump` step validates whether a version bump is required or not and if required then calculates the new version based on conventional commit type
1088+
- In the `docker-build-push` job we pass an dryrun argument to `cog-bump` step which only provides the version to be bumped.
1089+
- Then we build the image with this new version and test the changes.
1090+
- Once all the changes are verified in the CI we publish the latest version tags and publish a GitHub release with all the relevant changes.
10791091
1080-
This project is licensed under the MIT License - see the
1081-
[LICENSE.md](LICENSE.md) file for details
1092+
</details>
1093+
1094+
- We utilize [Cocogitto](https://github.com/cocogitto/cocogitto) to automate the process of creating [Semantic SemVer](http://semver.org/) GitHub releases for this repository.
1095+
- For information on the latest [releases](https://docs.github.com/en/repositories/releasing-projects-on-github/about-releases), please visit the Releases section of the repository.
1096+
- The release process is automated through GitHub Actions (GHA CI), following [Cocogitto's conventional commit types](https://docs.cocogitto.io/guide/commit.html)..
1097+
1098+
<details>
1099+
<summary>Click here for details on how the releases are automated in this repository.</summary>
1100+
1101+
#### GHA CI Release Process
1102+
- When a commit is made with a conventional commit type, the GHA CI pipeline is triggered.
1103+
- After all the validations the **docker-build-push** job runs the cog-bump step, which checks whether a version bump is necessary. If a bump is needed, it calculates the new version based on the conventional commit type.
1104+
- During this process, we pass a `dry-run: true` argument to the **cog-bump** step to only calculate (but not apply) the version bump.
1105+
- The CI pipeline then builds the Docker image with the new version and tests the changes.
1106+
- Once the changes are verified, the **create-release** job publishes new tags with bumped current version and a GitHub release is created.
1107+
</details>
1108+
1109+
### License
10821110
1111+
This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details

0 commit comments

Comments
 (0)