diff --git a/_config.yml b/_config.yml index ccf82b2..c5c3b35 100644 --- a/_config.yml +++ b/_config.yml @@ -5,8 +5,9 @@ description: > author: Jim Myhrberg url: https://commonflow.org -current_version: 1.0.0-rc.1 +current_version: 1.0.0-rc.2 versions: + - 1.0.0-rc.2 - 1.0.0-rc.1 exclude: diff --git a/docs/404.html b/docs/404.html index 5e41f7e..cb9a14d 100644 --- a/docs/404.html +++ b/docs/404.html @@ -39,6 +39,16 @@ +
  • + 1.0.0-rc.2 +
    • + + + + + + +
  • 1.0.0-rc.1
    • diff --git a/docs/css/main.css b/docs/css/main.css index ded4d81..5aabe68 100644 --- a/docs/css/main.css +++ b/docs/css/main.css @@ -112,6 +112,8 @@ h1 { font-size: 2.5em; line-height: 1.2; } ol ol, ul ol { list-style-type: lower-roman; } +ul ul ol, ul ol ol, ol ul ol, ol ol ol { list-style-type: lower-alpha; } + .content { margin-top: 80px; } .content a { word-break: break-word; } diff --git a/docs/index.html b/docs/index.html index 3f69576..87ec51d 100644 --- a/docs/index.html +++ b/docs/index.html @@ -8,8 +8,8 @@ -Git Common-Flow 1.0.0-rc.1 | Git Common Flow - +Git Common-Flow 1.0.0-rc.2 | Git Common Flow + @@ -18,7 +18,7 @@ +{"@context":"http://schema.org","@type":"WebSite","name":"Git Common Flow","headline":"Git Common-Flow 1.0.0-rc.2","author":{"@type":"Person","name":"Jim Myhrberg"},"description":"An attempt to gather a sensible selection of the most common usage patterns of git into a single and concise specification.","url":"https://commonflow.org/"} @@ -39,7 +39,17 @@ -
  • +
  • + 1.0.0-rc.2 +
    • + + + + + + + +
  • 1.0.0-rc.1
    • @@ -50,9 +60,9 @@
    -

    Git Common-Flow 1.0.0-rc.1

    +

    Git Common-Flow 1.0.0-rc.2

    -

    +

    Summary

    @@ -79,17 +89,12 @@ rebasing.
  • Merge Target - A branch that is the intended merge target for a change branch. Typically the merge target branch will be the same as the source branch.
    • -
  • Maintenance Branches - Used for maintaining old versions and releasing -PATCH updates when the master branch has moved on. Should follow a -stable-X.Y naming pattern, where X is MAJOR version and Y is MINOR -version.
  • Pull Request - A means of requesting that a change branch is merged in to its merge target, allowing others to review, discuss and approve the changes.
    • -
  • Release - Consists of a version bump commit directly on the master branch, -and a git tag named according to the new version string placed on said commit.
    • -
  • Maintenance Release - Just like a regular release, except the version bump -commit and release tag are on a maintenance branch instead of the master -branch.
    • +
  • Release - Consists of a version bump commit, and a git tag named according +to the new version string placed on said commit.
    • +
  • Release Branches - Used both for short-term preparations of a release, and +also for long-term maintenance of older version.

    • Git Common-Flow Specification (Common-Flow)

    @@ -106,61 +111,46 @@ interpreted as described in RFC 21
  • The master branch MUST be considered bleeding edge.
  • The master branch MUST always be in a non-broken state with its test suite passing.
    • -
  • The master branch SHOULD always be in a "as near as possible ready for -release/production" state to reduce the friction of creating a new +
  • The master branch SHOULD always be in a "as near as possibly ready for +release/production" state to reduce any friction with creating a new release.
    • -
  • Changes +
  • Change Branches
      -
    1. Changes MUST be performed on a separate branch that SHOULD be referred to -as a "change branch". All change branches MUST have descriptive names. It -is RECOMMENDED that you commit often locally, and you SHOULD regularly -push your work to the same named branch on the remote server.
      2. +
    2. Each change (feature, bugfix, etc.) MUST be performed on separate +branches that SHOULD be referred to as "change branches". All change +branches MUST have descriptive names. It is RECOMMENDED that you commit +often locally, and you SHOULD regularly push your work to the same named +branch on the remote server.
      3. +
    3. You MUST create separate change branches for each distinctly different +change. You MUST NOT include multiple unrelated changes into a single +change branch.
    4. When a change branch is created, the branch that it is created from SHOULD be referred to as the "source branch". Each change branch also -needs a designated "merge target branch", typically this will be the same +needs a designated "merge target" branch, typically this will be the same as the source branch.
    5. Change branches MUST be regularly updated with any changes from their source branch. This MUST be done by rebasing the change branch on top of -the source branch. To be clear you MUST NOT merge a source branch into a -change branch.
      6. +the source branch.
    6. After rebasing a change branch on top of its source branch you MUST push -the change branch to the remote server. This will require you do a force -push, and you SHOULD use the "--force-with-lease" git push option.
      7. -
    7. To merge a change branch into its merge target branch, you MUST open a -"pull request" (or equivalent) so others can review and approve your -changes.
      8. +the change branch to the remote server. This will require you to do a +force push, and you SHOULD use the "--force-with-lease" git push option. +
    +
    • +
  • Pull Requests +
      +
    1. To merge a change branch into its merge target, you MUST open a "pull +request" (or equivalent) so others can review and approve your changes.
    2. A pull request MUST only be merged when the change branch is up-to-date with its source branch, the test suite is passing, and you and others are happy with the change. This is especially important if the merge target is the master branch.
    3. To get feedback, help, or generally just discuss a change branch with -others, it is RECOMMENDED you do this by creating a pull request and +others, the RECOMMENDED way to do so is by creating a pull request and discuss the changes with others there.
    • -
  • Git Best Practices -
      -
    1. All commit messages SHOULD follow the Commit Guidelines and format from -the official git -documentation: -https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project
      2. -
    2. You SHOULD always use "--force-with-lease" when doing a force push. The -plain "--force" option is dangerous and destructive. More -information: -https://developer.atlassian.com/blog/2015/04/force-with-lease/
      3. -
    3. You SHOULD understand and be comfortable with -rebasing: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
      4. -
    4. It is RECOMMENDED that you always do "git pull --rebase" instead of "git -pull" to avoid unnecessary merge commits. You can make this the default -behavior of "git pull" with "git config --global pull.rebase true".
      5. -
    5. It is RECOMMENDED that all branches be merged using "git merge --no-ff". -This makes sure the reference to the original branch is kept in the commits, -allows one to revert a merge by reverting a single merge commit, and creates -a merge commit to mark the integration of the branch with master.
      6. -
    -
  • Versioning
    1. The project MUST have its version hard-coded somewhere in the @@ -176,16 +166,20 @@ is bad, and "2.11.4" is good.
    2. Releases
        -
      1. 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 -project. The version bump commit MUST have a git tag created on it and -named as the exact version string.
        2. -
      2. A version bump commit MUST have a commit message title of "Bump version +
      3. To create a new release, you MUST create a "version bump" commit which +changes the hard-coded version string of the project. The version bump +commit MUST have a git tag created on it and named as the exact version +string.
        4. +
      4. If you are not using a release branch, then the version bump commit MUST +be created directly on the master branch.
        5. +
      5. The 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 first line of the commit message MUST read: "Bump version to 2.11.4"
      6. 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 -"v". For example the tag name can be either "2.11.4" or "v2.11.4".
        7. +"v". For example the tag name can be either "2.11.4" or "v2.11.4". You +MUST not use a mix of "v" prefixed and non-prefixed tags. Pick one form +and stick to it.
      7. It is RECOMMENDED that release tags are lightweight tags, but you can OPTIONALLY use annotated tags if you want to include changelog information in the release tag itself.
        8. @@ -195,44 +189,94 @@ 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.
      3. +
    3. Release Branches +
        +
      1. Any branch that has a name starting with "release-" SHOULD be referred to +as a "release branch".
        2. +
      2. Use of release branches is OPTIONAL.
        3. +
      3. Changes in a release branch SHOULD typically come from work being +done against the master branch. Meaning changes SHOULD only trickle +downwards from the master branch. If a change needs to trickle back up +into the master branch, that work should have happened against the master +branch in the first place. One exception to this is version bump commits.
        4. +
      4. There are two types of release branches; short-term, and long-term.
        5. +
      5. Short-Term Release Branches +
          +
        1. Used for creating a specific versioned release.
          2. +
        2. A short-term release branch is RECOMMENDED if there is a lengthy +pre-release verification process to avoid a code freeze on the master +branch.
          3. +
        3. MUST have a name of "release-VERSION". For example for version +"2.11.4" the release branch name MUST be "release-2.11.4".
          4. +
        4. When using a short-term release branch, the version bump commit and +release tag MUST be made directly on the release branch itself.
          5. +
        5. Only very minor changes should be performed on a short-term release +branch directly. Any larger changes SHOULD be done in the master +branch, and SHOULD be pulled into the release branch by rebasing it +on top of the master branch the same way a change branch pulls in +updates from its source branch.
          6. +
        6. After the version bump commit and release tag have been created, the +release branch MUST be merged back into its source branch and then +deleted. Typically the source branch will be the master branch.
          7. +
        +
        6. +
      6. Long-Term Release Branches +
          +
        1. Used for work on versions which are not currently part of the master +branch. Typically this is useful when you need to create a new +maintenance release for a older version.
          2. +
        2. The branch name MUST have a non-specific version number. For example +a long-term release branch for creating new 2.9.x releases would be +named "release-2.9".
          3. +
        3. To create a new release from a long-term release branch, you MUST +create a version bump commit and release tag directly on the release +branch.
          4. +
        4. A long-term release branch MUST be created from the relevant release +tag. For example if the master branch is on version 2.11.4 and there +is a security fix for all 2.9.x releases, the latest of which is +"2.9.7". Create a new branch called "release-2.9" off of the "2.9.7" +release tag. The security fix release will then end up being version +"2.9.8".
          5. +
        +
        7. +
      +
    4. Bug Fixes & Rollback
      1. You MUST NOT under any circumstances force push to the master branch.
        2. -
      2. If a change branch which has been merged in to the master branch is found +
      3. If a change branch which has been merged into the master branch is found to have a bug in it, the bug fix work MUST be done as a new separate change branch and MUST follow the same workflow as any other change branch.
        4. -
      4. If a change branch is wrongfully merged in to master, or for any other +
      5. If a change branch is wrongfully merged into master, or for any other reason the merge must be undone, you MUST undo the merge by reverting the merge commit itself. Effectively creating a new commit that reverses all the relevant changes.
      5. -
    5. Maintenance Releases +
    6. Git Best Practices
        -
      1. Any branch that has a name starting with "stable-" SHOULD be referred to -as a "maintenance branch".
        2. -
      2. Maintenance branches are used for managing new releases of older -versions. Typically this is used to provide security updates for older -versions when the master branch has moved on to a point that a new -release for the old version cannot be made from the master branch.
        3. -
      3. A "maintenance release" is identical to a regular release, except the -version bump commit and the release tag are placed on the maintenance -branch instead of on the master branch.
        4. -
      4. A maintenance branch SHOULD follow a "stable-X.Y" naming pattern, where -"X" is the MAJOR version and "Y" is the minor version.
        5. -
      5. A maintenance branch MUST be created from the relevant release tag. For -example if there is a security fix for all 2.9.x releases, the latest of -which is "2.9.7", we create a new branch called "stable-2.9" off of the -"2.9.7" release tag. The security fix release will then end up being -version "2.9.8".
        6. -
      6. When working on a maintenance release, the relevant maintenance branch -MUST be thought of as the master branch for that maintenance work.
        7. -
      7. Changes in a maintenance branch SHOULD typically come from work being -done against the master branch. Meaning changes SHOULD only trickle -downwards from the master branch. If a change needs to trickle back up -into the master branch, that work should have happened against the master -branch in the first place.
        8. +
      8. All commit messages SHOULD follow the Commit Guidelines and format from +the official git +documentation: +https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project
        9. +
      9. You SHOULD never blindly commit all changes with "git commit -a". It is +RECOMMENDED you use "git add -i" to add individual changes to the staging +area so you are fully aware of what you are committing.
        10. +
      10. You SHOULD always use "--force-with-lease" when doing a force push. The +regular "--force" option is dangerous and destructive. More +information: +https://developer.atlassian.com/blog/2015/04/force-with-lease/
        11. +
      11. You SHOULD understand and be comfortable with +rebasing: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
        12. +
      12. It is RECOMMENDED that you always do "git pull --rebase" instead of "git +pull" to avoid unnecessary merge commits. You can make this the default +behavior of "git pull" with "git config --global pull.rebase true".
        13. +
      13. It is RECOMMENDED that all branches be merged using "git merge --no-ff". +This makes sure the reference to the original branch is kept in the +commits, allows one to revert a merge by reverting a single merge commit, +and creates a merge commit to mark the integration of the branch with +master.
    diff --git a/docs/sitemap.xml b/docs/sitemap.xml index 7e7120f..2637737 100644 --- a/docs/sitemap.xml +++ b/docs/sitemap.xml @@ -4,7 +4,7 @@ https://commonflow.org/spec/1.0.0-rc.1.html -https://commonflow.org/404.html +https://commonflow.org/spec/1.0.0-rc.2.html https://commonflow.org/ diff --git a/docs/spec/1.0.0-rc.1.html b/docs/spec/1.0.0-rc.1.html index 67b592d..f714467 100644 --- a/docs/spec/1.0.0-rc.1.html +++ b/docs/spec/1.0.0-rc.1.html @@ -39,6 +39,16 @@ +
  • + 1.0.0-rc.2 +
    • + + + + + + +
  • 1.0.0-rc.1
    • diff --git a/docs/spec/1.0.0-rc.2.html b/docs/spec/1.0.0-rc.2.html new file mode 100644 index 0000000..6dec624 --- /dev/null +++ b/docs/spec/1.0.0-rc.2.html @@ -0,0 +1,302 @@ + + + + + + + + + + +Git Common-Flow 1.0.0-rc.2 | Git Common Flow + + + + + + + + + + + + + +
    + + + + + +
    +
    +

    Git Common-Flow 1.0.0-rc.2

    + +

    + +

    Summary

    + +

    Common-Flow is an attempt to gather a sensible selection of the most common +usage patterns of git into a single and concise specification. It is based on +the original variant +of GitHub Flow, while taking +into account how a lot of open source projects use git.

    + +

    TL;DR: Common-Flow is basically GitHub Flow with the addition of versioned +releases, maintenance releases for old versions, and without the requirement to +deploy to production all the time.

    + +

    Terminology

    + +
      +
    • Master Branch - Must always have passing tests, is considered bleeding +edge, and must be named master.
      • +
    • Change Branches - Any branch that introduces changes like a new feature, a +bug fix, etc.
      • +
    • Source Branch - The branch that a change branch was created from. New +changes in the source branch should be incorporated into the change branch via +rebasing.
      • +
    • Merge Target - A branch that is the intended merge target for a change +branch. Typically the merge target branch will be the same as the source +branch.
      • +
    • Pull Request - A means of requesting that a change branch is merged in to +its merge target, allowing others to review, discuss and approve the changes.
      • +
    • Release - Consists of a version bump commit, and a git tag named according +to the new version string placed on said commit.
      • +
    • Release Branches - Used both for short-term preparations of a release, and +also for long-term maintenance of older version.
      • +
    + +

    Git Common-Flow Specification (Common-Flow)

    + +

    The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", +"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be +interpreted as described in RFC 2119.

    + +
      +
    1. The Master Branch +
        +
      1. A branch named "master" MUST exist and it MUST be referred to as the +"master branch".
        2. +
      2. The master branch MUST be considered bleeding edge.
        3. +
      3. The master branch MUST always be in a non-broken state with its test +suite passing.
        4. +
      4. The master branch SHOULD always be in a "as near as possibly ready for +release/production" state to reduce any friction with creating a new +release.
        5. +
      +
      2. +
    2. Change Branches +
        +
      1. Each change (feature, bugfix, etc.) MUST be performed on separate +branches that SHOULD be referred to as "change branches". All change +branches MUST have descriptive names. It is RECOMMENDED that you commit +often locally, and you SHOULD regularly push your work to the same named +branch on the remote server.
        2. +
      2. You MUST create separate change branches for each distinctly different +change. You MUST NOT include multiple unrelated changes into a single +change branch.
        3. +
      3. When a change branch is created, the branch that it is created from +SHOULD be referred to as the "source branch". Each change branch also +needs a designated "merge target" branch, typically this will be the same +as the source branch.
        4. +
      4. Change branches MUST be regularly updated with any changes from their +source branch. This MUST be done by rebasing the change branch on top of +the source branch.
        5. +
      5. After rebasing a change branch on top of its source branch you MUST push +the change branch to the remote server. This will require you to do a +force push, and you SHOULD use the "--force-with-lease" git push option.
        6. +
      +
      3. +
    3. Pull Requests +
        +
      1. To merge a change branch into its merge target, you MUST open a "pull +request" (or equivalent) so others can review and approve your changes.
        2. +
      2. A pull request MUST only be merged when the change branch is up-to-date +with its source branch, the test suite is passing, and you and others are +happy with the change. This is especially important if the merge target +is the master branch.
        3. +
      3. To get feedback, help, or generally just discuss a change branch with +others, the RECOMMENDED way to do so is by creating a pull request and +discuss the changes with others there.
        4. +
      +
      4. +
    4. Versioning +
        +
      1. The project MUST have its version hard-coded somewhere in the +code-base. It is RECOMMENDED that this is done in a file called "VERSION" +located in the root of the project.
        2. +
      2. If you are using a "VERSION" file in the root of the project, this MUST +only contain the exact version string.
        3. +
      3. The version string SHOULD follow the Semantic Versioning +(http://semver.org/) format. Use of Semantic Versioning is OPTIONAL, +but the version string MUST NOT have a "v" prefix. For example "v2.11.4" +is bad, and "2.11.4" is good.
        4. +
      +
      5. +
    5. Releases +
        +
      1. To create a new release, you MUST create a "version bump" commit which +changes the hard-coded version string of the project. The version bump +commit MUST have a git tag created on it and named as the exact version +string.
        2. +
      2. If you are not using a release branch, then the version bump commit MUST +be created directly on the master branch.
        3. +
      3. The 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 +first line of the commit message MUST read: "Bump version to 2.11.4"
        4. +
      4. 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 +"v". For example the tag name can be either "2.11.4" or "v2.11.4". You +MUST not use a mix of "v" prefixed and non-prefixed tags. Pick one form +and stick to it.
        5. +
      5. It is RECOMMENDED that release tags are lightweight tags, but you can +OPTIONALLY use annotated tags if you want to include changelog +information in the release tag itself.
        6. +
      6. 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 +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.
        7. +
      +
      6. +
    6. Release Branches +
        +
      1. Any branch that has a name starting with "release-" SHOULD be referred to +as a "release branch".
        2. +
      2. Use of release branches is OPTIONAL.
        3. +
      3. Changes in a release branch SHOULD typically come from work being +done against the master branch. Meaning changes SHOULD only trickle +downwards from the master branch. If a change needs to trickle back up +into the master branch, that work should have happened against the master +branch in the first place. One exception to this is version bump commits.
        4. +
      4. There are two types of release branches; short-term, and long-term.
        5. +
      5. Short-Term Release Branches +
          +
        1. Used for creating a specific versioned release.
          2. +
        2. A short-term release branch is RECOMMENDED if there is a lengthy +pre-release verification process to avoid a code freeze on the master +branch.
          3. +
        3. MUST have a name of "release-VERSION". For example for version +"2.11.4" the release branch name MUST be "release-2.11.4".
          4. +
        4. When using a short-term release branch, the version bump commit and +release tag MUST be made directly on the release branch itself.
          5. +
        5. Only very minor changes should be performed on a short-term release +branch directly. Any larger changes SHOULD be done in the master +branch, and SHOULD be pulled into the release branch by rebasing it +on top of the master branch the same way a change branch pulls in +updates from its source branch.
          6. +
        6. After the version bump commit and release tag have been created, the +release branch MUST be merged back into its source branch and then +deleted. Typically the source branch will be the master branch.
          7. +
        +
        6. +
      6. Long-Term Release Branches +
          +
        1. Used for work on versions which are not currently part of the master +branch. Typically this is useful when you need to create a new +maintenance release for a older version.
          2. +
        2. The branch name MUST have a non-specific version number. For example +a long-term release branch for creating new 2.9.x releases would be +named "release-2.9".
          3. +
        3. To create a new release from a long-term release branch, you MUST +create a version bump commit and release tag directly on the release +branch.
          4. +
        4. A long-term release branch MUST be created from the relevant release +tag. For example if the master branch is on version 2.11.4 and there +is a security fix for all 2.9.x releases, the latest of which is +"2.9.7". Create a new branch called "release-2.9" off of the "2.9.7" +release tag. The security fix release will then end up being version +"2.9.8".
          5. +
        +
        7. +
      +
      7. +
    7. Bug Fixes & Rollback +
        +
      1. You MUST NOT under any circumstances force push to the master branch.
        2. +
      2. If a change branch which has been merged into the master branch is found +to have a bug in it, the bug fix work MUST be done as a new separate +change branch and MUST follow the same workflow as any other change +branch.
        3. +
      3. If a change branch is wrongfully merged into master, or for any other +reason the merge must be undone, you MUST undo the merge by reverting the +merge commit itself. Effectively creating a new commit that reverses all +the relevant changes.
        4. +
      +
      8. +
    8. Git Best Practices +
        +
      1. All commit messages SHOULD follow the Commit Guidelines and format from +the official git +documentation: +https://git-scm.com/book/en/v2/Distributed-Git-Contributing-to-a-Project
        2. +
      2. You SHOULD never blindly commit all changes with "git commit -a". It is +RECOMMENDED you use "git add -i" to add individual changes to the staging +area so you are fully aware of what you are committing.
        3. +
      3. You SHOULD always use "--force-with-lease" when doing a force push. The +regular "--force" option is dangerous and destructive. More +information: +https://developer.atlassian.com/blog/2015/04/force-with-lease/
        4. +
      4. You SHOULD understand and be comfortable with +rebasing: https://git-scm.com/book/en/v2/Git-Branching-Rebasing
        5. +
      5. It is RECOMMENDED that you always do "git pull --rebase" instead of "git +pull" to avoid unnecessary merge commits. You can make this the default +behavior of "git pull" with "git config --global pull.rebase true".
        6. +
      6. It is RECOMMENDED that all branches be merged using "git merge --no-ff". +This makes sure the reference to the original branch is kept in the +commits, allows one to revert a merge by reverting a single merge commit, +and creates a merge commit to mark the integration of the branch with +master.
        7. +
      +
      9. +
    + +

    About

    + +

    The Git Common-Flow specification is authored +by Jim Myhrberg.

    + +

    If you'd like to leave feedback, +please open an issue on GitHub.

    + +

    License

    + +

    Creative Commons - CC BY 3.0

    + + +
    +
    +
    + + + diff --git a/docs/spec/1.0.0-rc.2.svg b/docs/spec/1.0.0-rc.2.svg new file mode 100644 index 0000000..bfabef8 --- /dev/null +++ b/docs/spec/1.0.0-rc.2.svg @@ -0,0 +1,2 @@ + +
    Create change branch
    Create change branch
    Add commits
    Add commits
    Create pull request
    Create pull request
    Discuss, review, refactor
    Discuss, review, refactor
    Rebase if needed
    Rebase if needed
    Merge pull request
    Merge pull request
    2.12.0
    2.12.0
    Version bump commit & release tag
    Version bump commit & release tag
    2.11.0
    2.11.0
    Version bump commit & release tag
    Version bump commit & release tag     \ No newline at end of file diff --git a/index.md b/index.md index 19c7f6c..f769686 100644 --- a/index.md +++ b/index.md @@ -1,11 +1,11 @@ --- -title: Git Common-Flow 1.0.0-rc.1 -version: 1.0.0-rc.1 +title: Git Common-Flow 1.0.0-rc.2 +version: 1.0.0-rc.2 --- -Git Common-Flow 1.0.0-rc.1 +Git Common-Flow 1.0.0-rc.2 ============================== - + Summary ------- @@ -33,17 +33,12 @@ Terminology - **Merge Target** - A branch that is the intended merge target for a change branch. Typically the merge target branch will be the same as the source branch. -- **Maintenance Branches** - Used for maintaining old versions and releasing - PATCH updates when the master branch has moved on. Should follow a - `stable-X.Y` naming pattern, where `X` is MAJOR version and `Y` is MINOR - version. - **Pull Request** - A means of requesting that a change branch is merged in to its merge target, allowing others to review, discuss and approve the changes. -- **Release** - Consists of a version bump commit directly on the master branch, - and a git tag named according to the new version string placed on said commit. -- **Maintenance Release** - Just like a regular release, except the version bump - commit and release tag are on a maintenance branch instead of the master - branch. +- **Release** - Consists of a version bump commit, and a git tag named according + to the new version string placed on said commit. +- **Release Branches** - Used both for short-term preparations of a release, and + also for long-term maintenance of older version. Git Common-Flow Specification (Common-Flow) ------------------------------------------- @@ -58,53 +53,38 @@ interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119). 2. The master branch MUST be considered bleeding edge. 3. The master branch MUST always be in a non-broken state with its test suite passing. - 4. The master branch SHOULD always be in a "as near as possible ready for - release/production" state to reduce the friction of creating a new + 4. The master branch SHOULD always be in a "as near as possibly ready for + release/production" state to reduce any friction with creating a new release. -2. Changes - 1. Changes MUST be performed on a separate branch that SHOULD be referred to - as a "change branch". All change branches MUST have descriptive names. It - is RECOMMENDED that you commit often locally, and you SHOULD regularly - push your work to the same named branch on the remote server. - 2. When a change branch is created, the branch that it is created from - SHOULD be referred to as the "source branch". Each change branch also - needs a designated "merge target branch", typically this will be the same - as the source branch. - 3. Change branches MUST be regularly updated with any changes from their - source branch. This MUST be done by rebasing the change branch on top of - the source branch. To be clear you MUST NOT merge a source branch into a +2. Change Branches + 1. Each change (feature, bugfix, etc.) MUST be performed on separate + branches that SHOULD be referred to as "change branches". All change + branches MUST have descriptive names. It is RECOMMENDED that you commit + often locally, and you SHOULD regularly push your work to the same named + branch on the remote server. + 2. You MUST create separate change branches for each distinctly different + change. You MUST NOT include multiple unrelated changes into a single change branch. - 4. After rebasing a change branch on top of its source branch you MUST push - the change branch to the remote server. This will require you do a force - push, and you SHOULD use the "--force-with-lease" git push option. - 5. To merge a change branch into its merge target branch, you MUST open a - "pull request" (or equivalent) so others can review and approve your - changes. - 6. A pull request MUST only be merged when the change branch is up-to-date + 3. When a change branch is created, the branch that it is created from + SHOULD be referred to as the "source branch". Each change branch also + needs a designated "merge target" branch, typically this will be the same + as the source branch. + 4. Change branches MUST be regularly updated with any changes from their + source branch. This MUST be done by rebasing the change branch on top of + the source branch. + 5. After rebasing a change branch on top of its source branch you MUST push + the change branch to the remote server. This will require you to do a + force push, and you SHOULD use the "--force-with-lease" git push option. +3. Pull Requests + 1. To merge a change branch into its merge target, you MUST open a "pull + request" (or equivalent) so others can review and approve your changes. + 2. A pull request MUST only be merged when the change branch is up-to-date with its source branch, the test suite is passing, and you and others are happy with the change. This is especially important if the merge target is the master branch. - 7. To get feedback, help, or generally just discuss a change branch with - others, it is RECOMMENDED you do this by creating a pull request and + 3. To get feedback, help, or generally just discuss a change branch with + others, the RECOMMENDED way to do so is by creating a pull request and discuss the changes with others there. -3. Git Best Practices - 1. All commit messages SHOULD follow the Commit Guidelines and format from - the official git - documentation: - - 2. You SHOULD always use "--force-with-lease" when doing a force push. The - plain "--force" option is dangerous and destructive. More - information: - - 3. You SHOULD understand and be comfortable with - rebasing: - 4. It is RECOMMENDED that you always do "git pull --rebase" instead of "git - pull" to avoid unnecessary merge commits. You can make this the default - behavior of "git pull" with "git config --global pull.rebase true". - 5. It is RECOMMENDED that all branches be merged using "git merge --no-ff". - This makes sure the reference to the original branch is kept in the commits, - allows one to revert a merge by reverting a single merge commit, and creates - a merge commit to mark the integration of the branch with master. 4. Versioning 1. The project MUST have its version hard-coded somewhere in the code-base. It is RECOMMENDED that this is done in a file called "VERSION" @@ -116,57 +96,102 @@ interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119). but the version string MUST NOT have a "v" prefix. For example "v2.11.4" is bad, and "2.11.4" is good. 5. Releases - 1. 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 - project. The version bump commit MUST have a git tag created on it and - named as the exact version string. - 2. A version bump commit MUST have a commit message title of "Bump version + 1. To create a new release, you MUST create a "version bump" commit which + changes the hard-coded version string of the project. The version bump + commit MUST have a git tag created on it and named as the exact version + string. + 2. If you are not using a release branch, then the version bump commit MUST + be created directly on the master branch. + 3. The 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 first line of the commit message MUST read: "Bump version to 2.11.4" - 3. The release tag on the version bump commit MUST be named exactly the same + 4. 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 - "v". For example the tag name can be either "2.11.4" or "v2.11.4". - 4. It is RECOMMENDED that release tags are lightweight tags, but you can + "v". For example the tag name can be either "2.11.4" or "v2.11.4". You + MUST not use a mix of "v" prefixed and non-prefixed tags. Pick one form + and stick to it. + 5. It is RECOMMENDED that release tags are lightweight tags, but you can OPTIONALLY use annotated tags if you want to include changelog information in the release tag itself. - 5. If you use annotated release tags, the first line of the annotation MUST + 6. 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 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. -6. Bug Fixes & Rollback - 1. You MUST NOT under any circumstances force push to the master branch. - 2. If a change branch which has been merged in to the master branch is found - to have a bug in it, the bug fix work MUST be done as a new separate - change branch and MUST follow the same workflow as any other change - branch. - 3. If a change branch is wrongfully merged in to master, or for any other - reason the merge must be undone, you MUST undo the merge by reverting the - merge commit itself. Effectively creating a new commit that reverses all - the relevant changes. -7. Maintenance Releases - 1. Any branch that has a name starting with "stable-" SHOULD be referred to - as a "maintenance branch". - 2. Maintenance branches are used for managing new releases of older - versions. Typically this is used to provide security updates for older - versions when the master branch has moved on to a point that a new - release for the old version cannot be made from the master branch. - 3. A "maintenance release" is identical to a regular release, except the - version bump commit and the release tag are placed on the maintenance - branch instead of on the master branch. - 3. A maintenance branch SHOULD follow a "stable-X.Y" naming pattern, where - "X" is the MAJOR version and "Y" is the minor version. - 4. A maintenance branch MUST be created from the relevant release tag. For - example if there is a security fix for all 2.9.x releases, the latest of - which is "2.9.7", we create a new branch called "stable-2.9" off of the - "2.9.7" release tag. The security fix release will then end up being - version "2.9.8". - 5. When working on a maintenance release, the relevant maintenance branch - MUST be thought of as the master branch for that maintenance work. - 6. Changes in a maintenance branch SHOULD typically come from work being +6. Release Branches + 1. Any branch that has a name starting with "release-" SHOULD be referred to + as a "release branch". + 2. Use of release branches is OPTIONAL. + 3. Changes in a release branch SHOULD typically come from work being done against the master branch. Meaning changes SHOULD only trickle downwards from the master branch. If a change needs to trickle back up into the master branch, that work should have happened against the master - branch in the first place. + branch in the first place. One exception to this is version bump commits. + 4. There are two types of release branches; short-term, and long-term. + 5. Short-Term Release Branches + 1. Used for creating a specific versioned release. + 2. A short-term release branch is RECOMMENDED if there is a lengthy + pre-release verification process to avoid a code freeze on the master + branch. + 3. MUST have a name of "release-VERSION". For example for version + "2.11.4" the release branch name MUST be "release-2.11.4". + 4. When using a short-term release branch, the version bump commit and + release tag MUST be made directly on the release branch itself. + 5. Only very minor changes should be performed on a short-term release + branch directly. Any larger changes SHOULD be done in the master + branch, and SHOULD be pulled into the release branch by rebasing it + on top of the master branch the same way a change branch pulls in + updates from its source branch. + 6. After the version bump commit and release tag have been created, the + release branch MUST be merged back into its source branch and then + deleted. Typically the source branch will be the master branch. + 6. Long-Term Release Branches + 1. Used for work on versions which are not currently part of the master + branch. Typically this is useful when you need to create a new + maintenance release for a older version. + 2. The branch name MUST have a non-specific version number. For example + a long-term release branch for creating new 2.9.x releases would be + named "release-2.9". + 3. To create a new release from a long-term release branch, you MUST + create a version bump commit and release tag directly on the release + branch. + 4. A long-term release branch MUST be created from the relevant release + tag. For example if the master branch is on version 2.11.4 and there + is a security fix for all 2.9.x releases, the latest of which is + "2.9.7". Create a new branch called "release-2.9" off of the "2.9.7" + release tag. The security fix release will then end up being version + "2.9.8". +7. Bug Fixes & Rollback + 1. You MUST NOT under any circumstances force push to the master branch. + 2. If a change branch which has been merged into the master branch is found + to have a bug in it, the bug fix work MUST be done as a new separate + change branch and MUST follow the same workflow as any other change + branch. + 3. If a change branch is wrongfully merged into master, or for any other + reason the merge must be undone, you MUST undo the merge by reverting the + merge commit itself. Effectively creating a new commit that reverses all + the relevant changes. +8. Git Best Practices + 1. All commit messages SHOULD follow the Commit Guidelines and format from + the official git + documentation: + + 2. You SHOULD never blindly commit all changes with "git commit -a". It is + RECOMMENDED you use "git add -i" to add individual changes to the staging + area so you are fully aware of what you are committing. + 3. You SHOULD always use "--force-with-lease" when doing a force push. The + regular "--force" option is dangerous and destructive. More + information: + + 4. You SHOULD understand and be comfortable with + rebasing: + 5. It is RECOMMENDED that you always do "git pull --rebase" instead of "git + pull" to avoid unnecessary merge commits. You can make this the default + behavior of "git pull" with "git config --global pull.rebase true". + 6. It is RECOMMENDED that all branches be merged using "git merge --no-ff". + This makes sure the reference to the original branch is kept in the + commits, allows one to revert a merge by reverting a single merge commit, + and creates a merge commit to mark the integration of the branch with + master. About ----- diff --git a/spec/1.0.0-rc.2.md b/spec/1.0.0-rc.2.md new file mode 100644 index 0000000..f769686 --- /dev/null +++ b/spec/1.0.0-rc.2.md @@ -0,0 +1,209 @@ +--- +title: Git Common-Flow 1.0.0-rc.2 +version: 1.0.0-rc.2 +--- +Git Common-Flow 1.0.0-rc.2 +============================== + + + +Summary +------- + +Common-Flow is an attempt to gather a sensible selection of the most common +usage patterns of git into a single and concise specification. It is based on +the [original variant](http://scottchacon.com/2011/08/31/github-flow.html) +of [GitHub Flow](https://guides.github.com/introduction/flow/), while taking +into account how a lot of open source projects use git. + +TL;DR: Common-Flow is basically GitHub Flow with the addition of versioned +releases, maintenance releases for old versions, and without the requirement to +deploy to production all the time. + +Terminology +----------- + +- **Master Branch** - Must always have passing tests, is considered bleeding + edge, and must be named `master`. +- **Change Branches** - Any branch that introduces changes like a new feature, a + bug fix, etc. +- **Source Branch** - The branch that a change branch was created from. New + changes in the source branch should be incorporated into the change branch via + rebasing. +- **Merge Target** - A branch that is the intended merge target for a change + branch. Typically the merge target branch will be the same as the source + branch. +- **Pull Request** - A means of requesting that a change branch is merged in to + its merge target, allowing others to review, discuss and approve the changes. +- **Release** - Consists of a version bump commit, and a git tag named according + to the new version string placed on said commit. +- **Release Branches** - Used both for short-term preparations of a release, and + also for long-term maintenance of older version. + +Git Common-Flow Specification (Common-Flow) +------------------------------------------- + +The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", +"SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be +interpreted as described in [RFC 2119](https://tools.ietf.org/html/rfc2119). + +1. The Master Branch + 1. A branch named "master" MUST exist and it MUST be referred to as the + "master branch". + 2. The master branch MUST be considered bleeding edge. + 3. The master branch MUST always be in a non-broken state with its test + suite passing. + 4. The master branch SHOULD always be in a "as near as possibly ready for + release/production" state to reduce any friction with creating a new + release. +2. Change Branches + 1. Each change (feature, bugfix, etc.) MUST be performed on separate + branches that SHOULD be referred to as "change branches". All change + branches MUST have descriptive names. It is RECOMMENDED that you commit + often locally, and you SHOULD regularly push your work to the same named + branch on the remote server. + 2. You MUST create separate change branches for each distinctly different + change. You MUST NOT include multiple unrelated changes into a single + change branch. + 3. When a change branch is created, the branch that it is created from + SHOULD be referred to as the "source branch". Each change branch also + needs a designated "merge target" branch, typically this will be the same + as the source branch. + 4. Change branches MUST be regularly updated with any changes from their + source branch. This MUST be done by rebasing the change branch on top of + the source branch. + 5. After rebasing a change branch on top of its source branch you MUST push + the change branch to the remote server. This will require you to do a + force push, and you SHOULD use the "--force-with-lease" git push option. +3. Pull Requests + 1. To merge a change branch into its merge target, you MUST open a "pull + request" (or equivalent) so others can review and approve your changes. + 2. A pull request MUST only be merged when the change branch is up-to-date + with its source branch, the test suite is passing, and you and others are + happy with the change. This is especially important if the merge target + is the master branch. + 3. To get feedback, help, or generally just discuss a change branch with + others, the RECOMMENDED way to do so is by creating a pull request and + discuss the changes with others there. +4. Versioning + 1. The project MUST have its version hard-coded somewhere in the + code-base. It is RECOMMENDED that this is done in a file called "VERSION" + located in the root of the project. + 2. If you are using a "VERSION" file in the root of the project, this MUST + only contain the exact version string. + 3. The version string SHOULD follow the Semantic Versioning + () format. Use of Semantic Versioning is OPTIONAL, + but the version string MUST NOT have a "v" prefix. For example "v2.11.4" + is bad, and "2.11.4" is good. +5. Releases + 1. To create a new release, you MUST create a "version bump" commit which + changes the hard-coded version string of the project. The version bump + commit MUST have a git tag created on it and named as the exact version + string. + 2. If you are not using a release branch, then the version bump commit MUST + be created directly on the master branch. + 3. The 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 + first line of the commit message MUST read: "Bump version to 2.11.4" + 4. 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 + "v". For example the tag name can be either "2.11.4" or "v2.11.4". You + MUST not use a mix of "v" prefixed and non-prefixed tags. Pick one form + and stick to it. + 5. It is RECOMMENDED that release tags are lightweight tags, but you can + OPTIONALLY use annotated tags if you want to include changelog + information in the release tag itself. + 6. 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 + 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. +6. Release Branches + 1. Any branch that has a name starting with "release-" SHOULD be referred to + as a "release branch". + 2. Use of release branches is OPTIONAL. + 3. Changes in a release branch SHOULD typically come from work being + done against the master branch. Meaning changes SHOULD only trickle + downwards from the master branch. If a change needs to trickle back up + into the master branch, that work should have happened against the master + branch in the first place. One exception to this is version bump commits. + 4. There are two types of release branches; short-term, and long-term. + 5. Short-Term Release Branches + 1. Used for creating a specific versioned release. + 2. A short-term release branch is RECOMMENDED if there is a lengthy + pre-release verification process to avoid a code freeze on the master + branch. + 3. MUST have a name of "release-VERSION". For example for version + "2.11.4" the release branch name MUST be "release-2.11.4". + 4. When using a short-term release branch, the version bump commit and + release tag MUST be made directly on the release branch itself. + 5. Only very minor changes should be performed on a short-term release + branch directly. Any larger changes SHOULD be done in the master + branch, and SHOULD be pulled into the release branch by rebasing it + on top of the master branch the same way a change branch pulls in + updates from its source branch. + 6. After the version bump commit and release tag have been created, the + release branch MUST be merged back into its source branch and then + deleted. Typically the source branch will be the master branch. + 6. Long-Term Release Branches + 1. Used for work on versions which are not currently part of the master + branch. Typically this is useful when you need to create a new + maintenance release for a older version. + 2. The branch name MUST have a non-specific version number. For example + a long-term release branch for creating new 2.9.x releases would be + named "release-2.9". + 3. To create a new release from a long-term release branch, you MUST + create a version bump commit and release tag directly on the release + branch. + 4. A long-term release branch MUST be created from the relevant release + tag. For example if the master branch is on version 2.11.4 and there + is a security fix for all 2.9.x releases, the latest of which is + "2.9.7". Create a new branch called "release-2.9" off of the "2.9.7" + release tag. The security fix release will then end up being version + "2.9.8". +7. Bug Fixes & Rollback + 1. You MUST NOT under any circumstances force push to the master branch. + 2. If a change branch which has been merged into the master branch is found + to have a bug in it, the bug fix work MUST be done as a new separate + change branch and MUST follow the same workflow as any other change + branch. + 3. If a change branch is wrongfully merged into master, or for any other + reason the merge must be undone, you MUST undo the merge by reverting the + merge commit itself. Effectively creating a new commit that reverses all + the relevant changes. +8. Git Best Practices + 1. All commit messages SHOULD follow the Commit Guidelines and format from + the official git + documentation: + + 2. You SHOULD never blindly commit all changes with "git commit -a". It is + RECOMMENDED you use "git add -i" to add individual changes to the staging + area so you are fully aware of what you are committing. + 3. You SHOULD always use "--force-with-lease" when doing a force push. The + regular "--force" option is dangerous and destructive. More + information: + + 4. You SHOULD understand and be comfortable with + rebasing: + 5. It is RECOMMENDED that you always do "git pull --rebase" instead of "git + pull" to avoid unnecessary merge commits. You can make this the default + behavior of "git pull" with "git config --global pull.rebase true". + 6. It is RECOMMENDED that all branches be merged using "git merge --no-ff". + This makes sure the reference to the original branch is kept in the + commits, allows one to revert a merge by reverting a single merge commit, + and creates a merge commit to mark the integration of the branch with + master. + +About +----- + +The Git Common-Flow specification is authored +by [Jim Myhrberg](http://jimeh.me). + +If you'd like to leave feedback, +please [open an issue on GitHub](https://github.com/jimeh/common-flow/issues). + +License +------- + +[Creative Commons - CC BY 3.0](http://creativecommons.org/licenses/by/3.0/) + diff --git a/spec/1.0.0-rc.2.svg b/spec/1.0.0-rc.2.svg new file mode 100644 index 0000000..bfabef8 --- /dev/null +++ b/spec/1.0.0-rc.2.svg @@ -0,0 +1,2 @@ + +
    Create change branch
    Create change branch
    Add commits
    Add commits
    Create pull request
    Create pull request
    Discuss, review, refactor
    Discuss, review, refactor
    Rebase if needed
    Rebase if needed
    Merge pull request
    Merge pull request
    2.12.0
    2.12.0
    Version bump commit & release tag
    Version bump commit & release tag
    2.11.0
    2.11.0
    Version bump commit & release tag
    Version bump commit & release tag     \ No newline at end of file