Skip to content

Commit fdda728

Browse files
committed
Update version bump process
Why is this change needed? -------------------------- We should rely on the generator to change the version number in all the various generated locations instead of manually changing it. This will be less error prone, especially if the locations of the generated version numbers change. How does it address the issue? ------------------------------ Switch to updating the version number in the generator config then regenerating. Note that `DocRaptor.nuspec` is still manual. Probably the build/release process should be updated to use `src/DocRaptor/DocRaptor.nuspec` instead, but that is out of scope for the moment. Any links to any relevant tickets, articles, or other resources? --------------------------------------------------------------- https://3.basecamp.com/3093825/buckets/29124557/todos/5284412189 https://3.basecamp.com/3093825/buckets/29124557/todos/5284421778 Any screenshots? ---------------- Did you complete all of the following? -------------------------------------- - Run test suite? - Add new tests? - Consider security implications and practices?
1 parent 8d60921 commit fdda728

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

README.md

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -83,20 +83,21 @@ Don't let swagger downgrade RestSharp to 105.1.0; it will try.
8383
1. Pull latest master
8484
2. Merge feature branch(es) into master
8585
3. `script/test`
86-
4. Increment version in code:
86+
4. Increment version:
8787
- `generator-config.json`
8888
- `DocRaptor.nuspec`
89-
- `src/main/csharp/DocRaptor/Properties/AssemblyInfo.cs`
90-
- `src/main/csharp/DocRaptor/Client/Configuration.cs` (2 places)
91-
5. Update [CHANGELOG.md](CHANGELOG.md)
92-
6. Commit "Release vX.Y.Z"
93-
7. Push to GitHub
94-
8. Tag version: `git tag 'vX.Y.Z' && git push --tags`
95-
9. Build package using `script/build`
96-
10. `script/nuget push bin/DocRaptor.X.Y.Z.nupkg <api_key> -Source https://api.nuget.org/v3/index.json`
97-
11. Verify package release at https://www.nuget.org/packages
98-
12. Open https://github.com/DocRaptor/docraptor-csharp/tags and make a new release for the version. Use the git tag as the name, CHANGELOG entries as the description, and attach `bin/*.dll` and `bin/*.xml` to the release
99-
13. Refresh documentation on docraptor.com
89+
5. Run `script/generate_language` to update generated version numbers:
90+
- `src/DocRaptor/Properties/AssemblyInfo.cs`
91+
- `src/DocRaptor/Client/Configuration.cs` (4 places)
92+
6. Update [CHANGELOG.md](CHANGELOG.md)
93+
7. Commit "Release vX.Y.Z"
94+
8. Push to GitHub
95+
9. Tag version: `git tag 'vX.Y.Z' && git push --tags`
96+
10. Build package using `script/build`
97+
11. `script/nuget push bin/DocRaptor.X.Y.Z.nupkg <api_key> -Source https://api.nuget.org/v3/index.json`
98+
12. Verify package release at https://www.nuget.org/packages
99+
13. Open https://github.com/DocRaptor/docraptor-csharp/tags and make a new release for the version. Use the git tag as the name, CHANGELOG entries as the description, and attach `bin/*.dll` and `bin/*.xml` to the release
100+
14. Refresh documentation on docraptor.com
100101

101102

102103
## Version Policy

0 commit comments

Comments
 (0)