Initial release planning

[ximon18]

This issue exists to track the remaining items that need to be done before we can make a release of dnst.

Below is an initial list of todo items in no particular order and likely incomplete:

• Prepare a blog post, website news article, etc? Decide on messaging regarding LDNS.
• Add a CHANGELOG.md.
• Update README.md #89
• Issue Docker Hub automation user credentials for the packaging workflow to use.
• Use a release version of domain: (actually only strictly needed if we want to publish dnst to crates.io)
  • Switch to a release version of domain. #80
  • FIX: Don't loop forever if an RR CLASS doesn't match the apex CLASS. domain#457? Or change signing not to support multiple CLASSes?
  • Attempt to give more context on unknown record type zone file parsing errors. domain#450
  • Add a static-openssl feature. domain#529
  • In-place zone parser yields incorrect TTLs. domain#537
• Packaging: Package dnst as DEB & RPM packages, and Docker images. #22
  • Depends on Upgrade cargo-generate-rpm to support %posttrans ploutos#120
  • Depends on Add a static-openssl feature. domain#529
  • Add install from packages steps to Read The Docs. #87
  • Separate ldns replacement package #145
  • Add docker docs and prepare for release candidate #143
• Man pages:
  • Minimally update dnst signzone man page. #77
  • Various man page updates and consistency tweaks. #84
• Reimplement (some) ldns sub commands #3
  • Finalize the signzone subcommand:
    • Add signzone command. #8
      • Fix signing of zones with early glue. #67
      • Add test for signzone -d. #69
      • Add tests for -b. #70
      • Add test for dnst signzone -L. #71
      • Add a test of '-u'. #72
      • Add integration tests for -p. #73
      • Add tests for -H. #74
      • signzone command line argument cleanup and additional checks. #75
      • Add test for -M. #76
• Use tracing_subscriber to print warnings and errors #62
  • Obsoletes Error reporting extensions. #36
• Make version argument handling more consistent. #86
• CLI Key Management #61
• Implement support for various record types domain#569
• Incomplete package cleanup and always using force overwrite symlinks #132

Possible additional items that could/should/must be done, to be determined:

• Improve dnst update user interface and functionality? #42
• Improve manual pages #30
• Avoid using the key tag in the filename for a key. #40
• Generate keys with unique key tags #41
• dnst-signzone should default iterations to zero #15
• Remove --algorithm from dnst signzone's NSEC3 options, as it only supports SHA-1 (the default)? #31
• Change fallback for digest algorithm in dnst key2ds from SHA-1 to SHA-256? #32
• dnst signzone produced TTLs differ to that of LDNS #43
• Confusing error (panic) when writing to a broken stdout/pipe #49
• Support algorithm numbers as input for dnst keygen. #52
• key2ds: Make hex output lowercase to match the original ldns. #65
• Add mechanism to control the log level #81
• ldns-signzone emulation orders output RRs differently to original ldns-signzone. #90

Items potentially out-of-scope, to be determined:

• Inconsistent option help style between our command line tools. #46
• Format keygen and key2ds subcommand output using tabs like ldns-keygen and ldns-key2ds. #48
  • Needs zonefile_fmt: fix handling of tabs when printing only rdata domain#516
• Add initial support for the ldns-testns command. #56
  • Add missing pieces needed to load data files accepted by ldns-testns as input. domain#489
• Inconsistent arguments for controlling output to stdout. #66
• Generate and include man pages from .rst sources ploutos#121
• Extend --ignored tests to use dnssec-verify as well as ldns-verify-zone. #82
• Add a Routinator-like man page output argument. #88

Other items not tracked anywhere that I know of:

• Add RDATA parsing support where missing for some RTYPES in domain.