mirror/stackexchange-dnscontrol
1
0
Fork 0
mirror of https://github.com/StackExchange/dnscontrol.git synced 2024-05-11 05:55:12 +00:00
Code Issues Releases Activity

DOCS: Clean up old docs and scripts (#1728)

Browse Source
This commit is contained in:
Tom Limoncelli
2022-08-31 08:34:24 -04:00
committed by GitHub
parent 391622ff55
commit a18710b284
4 changed files with 23 additions and 130 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@@ -198,8 +198,6 @@ See [dnscontrol-action](https://github.com/koenrh/dnscontrol-action)
- **Call for new volunteer maintainers for NAMEDOTCOM, and SOFTLAYER.** These providers have no maintainer. Maintainers respond to PRs and fix bugs in a timely manner, and try to stay on top of protocol changes.
- **ACME/Let's Encrypt support is frozen and will be removed after December 31, 2022.** The `get-certs` command (renews certs via Let's Encrypt) has no maintainer. There are other projects that do a better job. If you don't use this feature, please do not start. If you do use this feature, please plan on migrating to something else. See discussion in [issues/1400](https://github.com/StackExchange/dnscontrol/issues/1400)
- **Provider OCTODNS is frozen and will be removed after Nov 1, 2022.** It was written as a joke and nobody laughed. It's time to remove the code and move on.
- **convertzone is frozen and will be removed after June 30, 2022.** The `convertzone` stand-alone program is replaced by the `get-zone` subcommand of DNSControl. It does everything `convertzone` did and more.
- **Provider ACTIVEDIRECTORY_PS is frozen and will be removed after June 30, 2022.** It is replaced by MSDNS which is 100% feature compatible and works better. (We believe nobody uses it.)
- **get-zones syntax changes in v3.16** Starting in v3.16, the command line arguments for `dnscontrol get-zones` changes. For backwards compatibility change `provider` to `-`. See documentation for details.
## More info at our web site

70
bin/make-release.sh
View File

@@ -1,70 +0,0 @@
#!/bin/bash
echo -e
: "${1:?'Provide the version number as the first arg (v1.2.3, not 1.2.3).'}" ;
NEWVERSION="$1"
if [[ "$NEWVERSION" != v* ]]; then
echo "Version should start with v: v1.2.3, not 1.2.3."
exit 1
fi
git tag -d "$NEWVERSION"
PREVVERSION="$(git tag --list '[vV]*' --sort=v:refname |tail -1)"
echo '=========='
echo '== current version:' "$PREVVERSION"
echo '== new version:' "$NEWVERSION"
git checkout -b release_"$NEWVERSION" || true
sed -i.bak -e 's/Version = ".*"/Version = "'"$NEWVERSION"'"/g' main.go
git commit -m'Release '"$NEWVERSION" main.go
git tag -f "$NEWVERSION"
git push --delete origin "$NEWVERSION"
git push origin tag "$NEWVERSION"
echo ======= Creating: draft-notes.txt
echo >draft-notes.txt '
This release includes many new providers (FILL IN), dozens
of bug fixes, and FILL IN.
## Breaking changes:
* FILL IN
## Major features:
* FILL IN
## Provider-specific changes:
* FILL IN
## Other changes and improvements:
* FILL IN
## Depreciation warnings
'
git log "$NEWVERSION"..."$PREVVERSION" >>draft-notes.txt
git push --set-upstream origin "release_$NEWVERSION"
echo "NEXT STEP:
1. Create a PR:
open \"https://github.com/StackExchange/dnscontrol/compare/master...release_$NEWVERSION\"
2. Edit draft-notes.txt into actual release notes.
3. Verify tests complete successfully.
4. Merge the PR when satisfied.
5. Promote the release.
"

43
build.ps1
View File

@@ -1,43 +0,0 @@
param (
[string]$SHA = ""
)
if ($SHA -eq ""){
$SHA = (git rev-parse HEAD) | Out-String
$SHA = $SHA.Replace([System.Environment]::NewLine,"")
}
$PKG = "github.com/StackExchange/dnscontrol"
$DATE = [int][double]::Parse((Get-Date -UFormat %s))
$FLAGS="-mod=readonly -s -w -X main.SHA=$SHA -X main.BuildTime=$DATE"
Write-Host $FLAGS
$OrigGOOS = $env:GOOS
$env:GO111MODULE = "on"
Write-Host 'Building Linux'
$env:GOOS = "linux"
go build -o dnscontrol-Linux -ldflags "$FLAGS" $PKG
Write-Host 'Building Windows'
$env:GOOS = "windows"
go build -o dnscontrol.exe -ldflags "$FLAGS" $PKG
Write-Host 'Building Darwin'
$env:GOOS = "darwin"
go build -o dnscontrol-Darwin -ldflags "$FLAGS" $PKG
$env:GOOS = $OrigGOOS
#No compression if building on windows
<#
if [ "$COMPRESS" = "1" ]
then
echo 'Compressing executables'
upx dnscontrol.exe
upx dnscontrol-Linux
upx dnscontrol-Darwin
fi
#>

38
docs/release-engineering.md
View File

@@ -10,19 +10,20 @@ These are the instructions for producing a release.
CircleCI will do most of the work for you. You will need to edit the draft release notes.
Please change the version number as appropriate. Substitute (for example)
`3.19.0` any place you see `VERSION` in this doc.
`3.20.0` any place you see `VERSION` in this doc.
## Step 1. Tag the commit in master that you want to release
```shell
git tag -a v3.19.0
git checkout master
git tag -a v3.20.0
git push origin --tags
```
See [Git Docs](https://git-scm.com/book/en/v2/Git-Basics-Tagging) for more examples.
Soon after
CircleCI will start a [build](https://app.circleci.com/pipelines/github/StackExchange/dnscontrol?branch=master) Workflow and produce all of the artifacts for the release.
CircleCI will start a [build](https://app.circleci.com/pipelines/github/StackExchange/dnscontrol) Workflow and produce all of the artifacts for the release.
![CircleCI Release Screenshot](public/circleci_release.png)
@@ -45,24 +46,31 @@ Release notes style guide:
See [https://github.com/StackExchange/dnscontrol/releases for examples](https://github.com/StackExchange/dnscontrol/releases) for recent release notes and copy that style.
Example/template:
Template:
```text
This release includes many new providers (JoeDNS and MaryDNS), dozens
of bug fixes, and a new testing framework that makes it easier to add
big features without fear of breaking old ones.
## Changelog
Major features:
This release includes many new providers (FILL IN), dozens
of bug fixes, and FILL IN.
* NEW PROVIDER: Providername (#issueid)
* Add FOO DNS record support (#issueid)
* Add SIP/JABBER labels to underscore exception list (#453)
### Breaking changes:
Provider-specific changes:
* FILL IN
* PROVIDER: New feature or thing (#issueid)
* PROVIDER: Another feature or bug fixed (#issueid)
* CLOUDFLARE: Fix CF trying to update non-changeable TTL (#issueid)
### Major features:
* FILL IN
### Provider-specific changes:
* FILL IN
### Other changes and improvements:
* FILL IN
### Depreciation warnings
```
## Step 2. Announce it via email