Skip to content

Commit 07c3842

Browse files
authored
Updating Readme (#383)
+semver:minor Releasing a newer version for VulnerableApp
1 parent e27a18e commit 07c3842

File tree

2 files changed

+24
-27
lines changed

2 files changed

+24
-27
lines changed

README.md

Lines changed: 0 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -40,33 +40,6 @@ There are multiple ways in which you can contribute to the project:
4040
1. If you are a developer and trying to start on to the project, then the suggestion is to go through the list of [issues](https://github.com/SasanLabs/VulnerableApp/issues) which contains `good first issue` which can be a good starter.
4141
2. If you are a developer or a security professional looking to add new Vulnerability type then you can Generate the Sample Vulnerability by running `./gradlew GenerateSampleVulnerability`. It will generate the Sample Vulnerability template which has placeholders and comments. Modified files can be seen in the logs of the command or in the github history. You can navigate to those files, fill in the placeholders and then build the project to see the effect of the changes.
4242
3. In case you are looking to contribute to the project by publicising it or working on the growth of the project, please feel free to add your thoughts to discussions section or issues and we can discuss over them.
43-
### Semantic Versioning ###
44-
Leveraging GitHub workflow and actions, semantic versioning is automated.
45-
When committing your feature, you have the option to increment the version's major, minor, or patch value
46-
by including <code>+semver:[major|minor|patch]</code> in your commit message. Major, minor, patch values are the
47-
strings 'major', 'minor', and 'patch'.
48-
49-
Examples:
50-
```properties
51-
git commit -m "some text +semver:major"
52-
git commit -m "+semver:minor some text"
53-
git commit -m "+semver:patch some text"
54-
```
55-
By default, if the version is not provided in the commit message, then patch is incremented.
56-
57-
The updated version is used to create a tag for the latest published release on GitHub and DockerHub.
58-
59-
<em>Which version should be incremented?</em>
60-
61-
<table>
62-
<thead><td>Version</td><td>Description</td></thead>
63-
<tr><td>Major</td><td>Changes that break backwards compatibility</td></tr>
64-
<tr><td>Minor</td><td>New features that are backwards compatible</td></tr>
65-
<tr><td>Patch</td><td>Bug fixes that are backwards compatible</td></tr>
66-
</table>
67-
More information can be found at <a href="https://semver.org/" alt="semantic versioning specification">Semantic
68-
Versioning
69-
Specifiction</a>.
7043

7144
## Building the project
7245
There are 2 ways in which this project can be built and used:

docs/ReleaseVulnerableApp.md

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Releasing VulnerableApp #
2+
3+
VulnerableApp is Leveraging GitHub workflow and actions for creating new releases automatically.
4+
When committing the feature, we have the option to increment the version's to major, minor, or patch value
5+
by including <code>+semver:[major|minor|patch]</code> in the commit message. Major, minor, patch values are the
6+
strings 'major', 'minor', and 'patch'.
7+
8+
Examples:
9+
```properties
10+
git commit -m "some text +semver:major"
11+
git commit -m "+semver:minor some text"
12+
git commit -m "+semver:patch some text"
13+
```
14+
By default, if the version is not provided in the commit message, then patch is incremented.
15+
Examples of version change considering the current version is 1.10.0:
16+
1. For patch release, the newer version will be 1.10.1
17+
2. For minor release, the newer version will be 1.11.0
18+
3. for major release, the newer version will be 2.0.0
19+
20+
The github action will create a tag for the latest published release on GitHub and DockerHub.
21+
22+
More information can be found at [Semantic
23+
Versioning
24+
Specifiction](https://semver.org/)

0 commit comments

Comments
 (0)