Mirrors/coredns
1
0
Fork 0
mirror of https://github.com/coredns/coredns.git synced 2025-10-26 15:54:16 -04:00
Code Issues Packages Projects Releases Wiki Activity

docs: Makefile.release and Makefile.doc (#2926)

Browse Source 
* add metrics for reload
* documented release process better
* run: Makefile.doc all to push reload doc to man-pages

Signed-off-by: Miek Gieben <miek@miek.nl>
This commit is contained in:
Miek Gieben
2019-06-26 11:18:03 +01:00
committed by GitHub
parent ad352cee88
commit d4d019d749
4 changed files with 45 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

42
Makefile.release
View File

@@ -5,30 +5,42 @@
# (after some sanity checks).
#
# The release should be accompanied by release notes in the notes/ subdirectory.
# These are published on coredns.io.
#
# For example: https://coredns.io/2016/09/18/coredns-001-release/ .
# These are published on coredns.io. For example see: notes/coredns-1.5.1.md
#
# Getting the authors for this release is done with the following command line
#
# git log --pretty=format:'%an' v$(VERSION)..master | sort -u
#
# Steps:
# * Up the version in coremain/version.go
# * Do a make -f Makefile.doc
# * go generate
# * Send PR to get this merged.
# Getting all pull requests merged since the last tag can be done with this "oneliner"
#
# * Open an issue for this release
# * In an issue give the command: /release: master VERSION
# Where VERSION is the version of the release - the release script double checks this with the
# actual CoreDNS version in coremain/version.go
# * (to test as release /release: -t master VERSION can be used.
# % git log $(git describe --tags --abbrev=0)..HEAD --oneline | awk ' { $1="";print } ' | sed 's/^ //' | sed -e 's|#\([0-9]\)|https://github.com/coredns/coredns/pull/\1|'
#
# As seen in notes/coredns-1.5.1.md we want to style the notes in the following manner:
#
# * important changes at the top
# * people who committed/review code (the latter is harder to get)
# * Slightly abbreviated list of pull requests merged for this release.
#
# Steps to release, first:
#
# 1. Up the version in coremain/version.go
# 2. Do a make -f Makefile.doc
# 3. go generate
# 4.* Send PR to get this merged.
#
# Then:
#
# 1. Open an issue for this release
# 2. In an issue give the command: /release: master VERSION
# Where VERSION is the version of the release - the release script double checks this with the
# actual CoreDNS version in coremain/version.go
# 3. (to test as release /release: -t master VERSION can be used.
#
# See https://github.com/coredns/release for documentation README on what needs to be setup for this to be
# automated (can still be done by hand if needed). Especially what environment variables need to be
# set!
# set! This further depends on Caddy being setup and [dreck](https://github.com/miekg/dreck) running as a plugin in Caddy.
#
# To release we run, these target from the this Makefile:
# To release we run, these target from the this Makefile.release ordered like:
# * make release
# * make docker
# * make github-push