From 07c3842e34d58a320a786e0718ca6689103916f3 Mon Sep 17 00:00:00 2001 From: Karan Preet Singh Sasan Date: Sun, 14 Aug 2022 07:54:56 +0530 Subject: [PATCH] Updating Readme (#383) +semver:minor Releasing a newer version for VulnerableApp --- README.md | 27 --------------------------- docs/ReleaseVulnerableApp.md | 24 ++++++++++++++++++++++++ 2 files changed, 24 insertions(+), 27 deletions(-) create mode 100644 docs/ReleaseVulnerableApp.md diff --git a/README.md b/README.md index 39451a99..7c647166 100644 --- a/README.md +++ b/README.md @@ -40,33 +40,6 @@ There are multiple ways in which you can contribute to the project: 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. 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. 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. -### Semantic Versioning ### -Leveraging GitHub workflow and actions, semantic versioning is automated. -When committing your feature, you have the option to increment the version's major, minor, or patch value -by including +semver:[major|minor|patch] in your commit message. Major, minor, patch values are the -strings 'major', 'minor', and 'patch'. - -Examples: -```properties -git commit -m "some text +semver:major" -git commit -m "+semver:minor some text" -git commit -m "+semver:patch some text" -``` -By default, if the version is not provided in the commit message, then patch is incremented. - -The updated version is used to create a tag for the latest published release on GitHub and DockerHub. - -Which version should be incremented? - - - - - - -
VersionDescription
MajorChanges that break backwards compatibility
MinorNew features that are backwards compatible
PatchBug fixes that are backwards compatible
-More information can be found at Semantic -Versioning -Specifiction. ## Building the project There are 2 ways in which this project can be built and used: diff --git a/docs/ReleaseVulnerableApp.md b/docs/ReleaseVulnerableApp.md new file mode 100644 index 00000000..9476191a --- /dev/null +++ b/docs/ReleaseVulnerableApp.md @@ -0,0 +1,24 @@ +# Releasing VulnerableApp # + +VulnerableApp is Leveraging GitHub workflow and actions for creating new releases automatically. +When committing the feature, we have the option to increment the version's to major, minor, or patch value +by including +semver:[major|minor|patch] in the commit message. Major, minor, patch values are the +strings 'major', 'minor', and 'patch'. + +Examples: +```properties +git commit -m "some text +semver:major" +git commit -m "+semver:minor some text" +git commit -m "+semver:patch some text" +``` +By default, if the version is not provided in the commit message, then patch is incremented. +Examples of version change considering the current version is 1.10.0: +1. For patch release, the newer version will be 1.10.1 +2. For minor release, the newer version will be 1.11.0 +3. for major release, the newer version will be 2.0.0 + +The github action will create a tag for the latest published release on GitHub and DockerHub. + +More information can be found at [Semantic +Versioning +Specifiction](https://semver.org/)