Skip to content
This repository was archived by the owner on Jun 1, 2023. It is now read-only.

Commit 9760f29

Browse files
authored
Add Release Process section to README (#191)
1 parent b07b7c6 commit 9760f29

File tree

1 file changed

+22
-0
lines changed

1 file changed

+22
-0
lines changed

README.md

+22
Original file line numberDiff line numberDiff line change
@@ -300,6 +300,27 @@ $ git add Assets Resources
300300
$ git commit
301301
```
302302

303+
## Release Process
304+
305+
> The following information is primarily for the benefit of project maintainers.
306+
> That said, if you have any suggestions for how to improve this process,
307+
> please let us know by [opening an issue][open an issue].
308+
309+
Follow these steps to release a new version of `swift-doc`:
310+
311+
- [x] Verify that the latest commit
312+
[passed all CI checks](https://github.com/SwiftDocOrg/swift-doc/actions?query=workflow%3ACI).
313+
- [x] Update the Changelog by creating a new heading for the release
314+
and modifying the last path component for the `unreleased` link reference.
315+
- [x] Update the [`version` constant](https://github.com/SwiftDocOrg/swift-doc/blob/master/Sources/swift-doc/main.swift#L25)
316+
in the command-line executable.
317+
- [x] Create a new commit with the message "Bump version to `$VERSION`",
318+
where `$VERSION` is a [SemVer]-compatible version number.
319+
- [x] Tag that commit with the tag name "`$VERSION`"
320+
- [x] Run the command `git push origin master --tags`
321+
- [x] Create a new [release](https://github.com/SwiftDocOrg/swift-doc/releases)
322+
that corresponds to the new tag.
323+
303324
## License
304325

305326
MIT
@@ -335,3 +356,4 @@ Mattt ([@mattt](https://twitter.com/mattt))
335356
[pcre]: https://en.wikipedia.org/wiki/Perl_Compatible_Regular_Expressions
336357
[dot]: https://en.wikipedia.org/wiki/DOT_(graph_description_language)
337358
[graphviz]: https://www.graphviz.org
359+
[semver]: https://semver.org

0 commit comments

Comments
 (0)