StackExchange/dnscontrol
1
1
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2025-02-24 07:33:03 +08:00
Code Issues Projects Releases Packages Wiki Activity

DOCS: Add fmtjson and "get co main" to releng docs

Browse source 
Release engineering docs should clarify that they
should start in "main".  Also add fmtjson instructions.

Added as requested.
This commit is contained in:
Tom Limoncelli 2025-01-04 09:37:59 -05:00
parent dd26354e0e
commit aa93615d79
1 changed files with 3 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
documentation/release-engineering.md
View file

@ -10,6 +10,7 @@ Please change the version number as appropriate. Substitute (for example)
## Step 0. Update dependencies
```shell
git checkout main
git checkout -b update_deps
go install github.com/oligot/go-mod-upgrade@latest
go-mod-upgrade
@ -23,6 +24,7 @@ git commit -a -m "CHORE: Update dependencies"
git checkout main
git pull
go fmt ./...
bin/fmtjson $(find . -type f -name \*.json -print)
go generate ./...
go mod tidy
git status
@ -32,7 +34,7 @@ There should be no modified files. If there are, check them in then start over f
```
git checkout -b gogenerate
git commit -a -m "Update generated files for $VERSION"
git commit -a -m "Update generated files"
```
## Step 2. Tag the commit in main that you want to release