jimeh/common-flow
1
0
Fork 0
mirror of https://github.com/jimeh/common-flow.git synced 2026-02-19 09:26:40 +00:00
Code Issues Packages Projects Releases Wiki Activity

Remove two requirements which are a bit out of scope

Browse Source
This commit is contained in:
Jim Myhrberg
2017-07-02 22:10:03 +01:00
parent 0b9eb0e749
commit 97dc8e202a
1 changed files with 5 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
common-flow.md
View File

@@ -90,28 +90,20 @@ interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119).
the version string MUST NOT have a "v" prefix. For example "v2.11.4" is the version string MUST NOT have a "v" prefix. For example "v2.11.4" is
bad, and "2.11.4" is good. bad, and "2.11.4" is good.
4. Releases 4. Releases
1. New releases SHOULD be created whenever the master branch has changed 1. To create a new release, you MUST create a "version bump" commit directly
enough since the last release that it is worthwhile to push those changes
out for wider use. It is RECOMMENDED to create new releases very often to
reduce the amount of change in each release.
2. Because the master branch is considered bleeding edge, before a new
release is created, the state of the master branch MUST be confirmed to
be release ready by ensuring all test suites pass and relevant people
are confident in delivering a new release.
3. To create a new release, you MUST create a "version bump" commit directly
on the master branch which changes the hard-coded version value of the on the master branch which changes the hard-coded version value of the
project. The version bump commit MUST have a git tag created on it and project. The version bump commit MUST have a git tag created on it and
named as the exact version string. named as the exact version string.
4. A version bump commit MUST have a commit message title of "Bump version 2. A version bump commit MUST have a commit message title of "Bump version
to VERSION". For example, if the new version string is "2.11.4", the to VERSION". For example, if the new version string is "2.11.4", the
first line of the commit message MUST read: "Bump version to 2.11.4" first line of the commit message MUST read: "Bump version to 2.11.4"
5. The release tag on the version bump commit MUST be named exactly the same 3. The release tag on the version bump commit MUST be named exactly the same
as the version string. The tag name can OPTIONALLY be prefixed with as the version string. The tag name can OPTIONALLY be prefixed with
"v". For example the tag name can be either "2.11.4" or "v2.11.4". "v". For example the tag name can be either "2.11.4" or "v2.11.4".
6. It is RECOMMENDED that release tags are lightweight tags, but you can 4. It is RECOMMENDED that release tags are lightweight tags, but you can
OPTIONALLY use annotated tags if you want to include changelog OPTIONALLY use annotated tags if you want to include changelog
information in the release tag itself. information in the release tag itself.
7. If you use annotated release tags, the first line of the annotation MUST 5. If you use annotated release tags, the first line of the annotation MUST
read "Release VERSION". For example for version "2.11.4" the first line read "Release VERSION". For example for version "2.11.4" the first line
of the tag annotation would read "Release 2.11.4". The second line must of the tag annotation would read "Release 2.11.4". The second line must
be blank, and the changelog MUST start on the third line. be blank, and the changelog MUST start on the third line.