Archives/loop
2
0
Fork 0
mirror of https://github.com/lightninglabs/loop synced 2024-11-11 13:11:12 +00:00
Code Issues Releases Wiki Activity
158e22f2a7
loop/release_notes.md
Martin Habovstiak 84582bbb88 Improve error handling of config file 
This makes two changes to handling of errors when configuration file
could not be loaded:

1. Only NotFound errors are considered OK - access errors and other FS
   issues are now treated as fatal.
2. Failing to load config file specified explicitly via `--configfile`
   option is alway a fatal error.

Rationale: If the configfile was specified explicitly then it indicates
the user really wishes to load it. While the user could want it to be
optionally loaded for extra configuration options, this can be
accomplished using an empty file.

If the config file was not specified explicitly then its' path was
computed from loop directory. If the file is inaccessible due to
permissions or other FS errors it's nearly certain other following
operations will fail as well. Failing early with a clear message is thus
beneficial.

This still leaves room for uncaught user error (e.g. mistakenly naming
config file inside loop dir as `loop.conf` instead of `loopd.conf`) but
it's greatly reduced and such error should be easier to identify.

(Indirectly) closes #412
2021-08-05 18:19:52 +02:00

1.4 KiB
Raw Blame History

Loop Client Release Notes

This file tracks release notes for the loop client.

Developers:

  • When new features are added to the repo, a short description of the feature should be added under the "Next Release" heading.
  • This should be done in the same PR as the change so that our release notes stay in sync!

Release Manager:

  • All of the items under the "Next Release" heading should be included in the release notes.
  • As part of the PR that bumps the client version, cut everything below the 'Next Release' heading.
  • These notes can either be pasted in a temporary doc, or you can get them from the PR diff once it is merged.
  • The notes are just a guideline as to the changes that have been made since the last release, they can be updated.
  • Once the version bump PR is merged and tagged, add the release notes to the tag on GitHub.

Next release

New Features

Breaking Changes

  • Failing to load configuration file specified by --configfile for any reason is now hard error. If you've used --configfile to mean "optional extra configuration" you will need to create an empty file. This was done in #413 to improve error reporting and avoid confusion. Similarly, failure to load any configuration file for reason other than NotFound is hard error, though this is not strictly breaking because such scenario would be already broken later.

Bug Fixes

Maintenance