Skip to content

Commit 26a7c41

Browse files
committed
Putting examples into repo as images
1 parent 5ee27f5 commit 26a7c41

9 files changed

+16
-12
lines changed
Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,11 @@
11
# Creating/Updating Examples
2-
The examples are generated by GitVersion tests, put into gists then use a service to render them as sequence diagrams.
2+
The examples are generated by GitVersion tests, there are a number of services which will then turn the sequence diagram text into an image to use in the docs. Here are some links which could be useful
33

4-
- [Plantuml gist rendering service](http://uml.mvnsearch.org)
4+
- [PlantUML Sequence Diagrams](http://www.plantuml.com/sequence.html)
5+
- [CodeUML Online editor](http://www.codeuml.com/)
6+
- [PlantText Online editor](http://www.planttext.com/planttext)
7+
- [PlantUML gist renderer](http://uml.mvnsearch.org)
58

69
The tests are quite simple. Using the methods on the `fixture` itself will record that action in the sequence diagram. If you do not want the action recorded perform the action directly on the repository (`fixture.Repository.`)
10+
11+
The tests for the examples should all live at [DocumentationSamples.cs](https://github.com/GitTools/GitVersion/blob/master/src/GitVersionCore.Tests/IntegrationTests/DocumentationSamples.cs)

docs/git-branching-strategies/gitflow-examples.md

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -2,46 +2,45 @@
22
## Feature Branches
33
Feature branches will take the feature branch name and use that as the pre-release tag.
44

5-
![GitFlow](http://uml.mvnsearch.org/gist/05119d0cd4ecaaefff94)
5+
![GitFlow](img/05119d0cd4ecaaefff94_feature-branch.png)
66

77

88
## Pull Request
99
Because feature branches are most likely pushed to a fork, we are showing the
1010
pull request branch name which is created when you submit a pull request
1111

12-
![GitFlow](http://uml.mvnsearch.org/gist/09fdf46995b771f3164a)
12+
![GitFlow](img/09fdf46995b771f3164a_pull-request.png)
1313

1414

1515
## Hotfix Branches
1616
Hotfix branches are used when you need to do a *patch* release in GitFlow and are always created off `master`
1717

18-
![GitFlow](http://uml.mvnsearch.org/gist/f26ae57adbd9b74f74c4)
18+
![GitFlow](img/f26ae57adbd9b74f74c4_hotfix.png)
1919

2020

2121
## Minor Release Branches
2222
Release branches are used for both major and minor releases for stabilisation before a release. Release branches are taken off `develop` then merged to both `develop` and `master`. Finally `master` is tagged with the released version.
2323

24-
![GitFlow](http://uml.mvnsearch.org/gist/6d33d35a70a777608fa1)
24+
![GitFlow](img/6d33d35a70a777608fa1_minor-release.png)
2525

2626

2727
## Major Release Branches
2828
Major releases are just like minor releases, the difference is you bump the major in the release branch name.
2929

30-
![GitFlow](http://uml.mvnsearch.org/gist/39f9d8b8b007c82f1f80)
30+
![GitFlow](img/39f9d8b8b007c82f1f80_major-release.png)
3131

3232

3333
## Support Branches
3434
Support branches are not really covered in GitFlow, but are essential if you need to maintain multiple major versions at the same time. You could use support branches for supporting minor releases as well. If you are just supporting the majors, then name your branch `support/<major>.x` (i.e `support/1.x`), to support minors use `support/<major>.<minor>.x` or `support/<major>.<minor>.0`. (i.e `support/1.3.x` or `support/1.3.0`)
3535

3636
### Hotfix
3737
Depending on what you name your support branch, you may or may not need a hotfix branch. Naming it `support/1.x` will automatically bump the patch, if you name it `support/1.3.0` then the version in branch name rule will kick in and the patch *will not* automatically bump, meaning you have to use hotfix branches.
38-
![GitFlow](http://uml.mvnsearch.org/gist/b035b8ca99bd34239518)
38+
![GitFlow](img/b035b8ca99bd34239518_support-hotfix.png)
3939

4040

4141
### Minor Release
42-
![GitFlow](http://uml.mvnsearch.org/gist/2167fb1c4a5cf84edfd8)
42+
![GitFlow](img/2167fb1c4a5cf84edfd8_support-minor.png)
4343

4444

45-
## Source
46-
47-
See `DocumentationSamples.GitFlowExample`. To update, modify then run test. Update [https://gist.github.com/JakeGinnivan/cf053d7f5d336ae9f7bb](https://gist.github.com/JakeGinnivan/cf053d7f5d336ae9f7bb)
45+
## To Update/Contribute
46+
See [creating/updating examples](creating-updating-examples.md)
Loading
Loading
Loading
Loading
Loading
Loading
Loading

0 commit comments

Comments
 (0)