Browse Source

developing: Add new release instructions.

tags/v0.10.2
Daniel Oaks 6 years ago
parent
commit
075a38d08d
1 changed files with 38 additions and 0 deletions
  1. 38
    0
      DEVELOPING.md

+ 38
- 0
DEVELOPING.md View File

@@ -7,6 +7,44 @@ I may also name the branch `develop+feature` if I'm developing multiple, or part
7 7
 The intent is to keep `master` relatively stable.
8 8
 
9 9
 
10
+## Releasing a new version
11
+
12
+1. Ensure dependencies are up-to-date.
13
+2. Run [`irctest`]() over it to make sure nothing's severely broken.
14
+3. Remove `-unreleased` from the version number in `irc/constants.go`.
15
+4. Update the changelog with new changes.
16
+5. Remove unused sections from the changelog, change the date/version number and write release notes.
17
+6. Commit the new changelog and constants change.
18
+7. Tag the release with `git tag v0.0.0 -m "Release v0.0.0"` (`0.0.0` replaced with the real ver number).
19
+8. Build binaries using the Makefile, upload release to Github including the changelog and binaries.
20
+
21
+Once it's built and released, you need to setup the new development version. To do so:
22
+
23
+1. In `irc/constants.go`, update the version number to `0.0.1-unreleased`, where `0.0.1` is the previous release number with the minor field incremented by one (for instance, `0.9.2` -> `0.9.3-unreleased`).
24
+2. At the top of the changelog, paste a new section with the content below.
25
+3. Commit the new version number and changelog with the message `"Setup v0.0.1-unreleased devel ver"`.
26
+
27
+**Unreleased changelog content**
28
+
29
+```md
30
+## Unreleased
31
+New release of Oragono!
32
+
33
+### Config Changes
34
+
35
+### Security
36
+
37
+### Added
38
+
39
+### Changed
40
+
41
+### Removed
42
+
43
+### Fixed
44
+```
45
+
46
+
47
+
10 48
 ## Updating `vendor/`
11 49
 
12 50
 The `vendor/` directory holds our dependencies. When we import new repos, we need to update this folder to contain these new deps. This is something that I'll mostly be handling.

Loading…
Cancel
Save