-
Notifications
You must be signed in to change notification settings - Fork 27
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
fix(release): added known issue text to release notes #671
Conversation
Docs for 2a046f1 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2578/docs/artifacts/html/index.html |
source/release-notes/rn_v92.inc
Outdated
Known Issues | ||
------------ | ||
|
||
There is now a known issue with regards to `fioconfig` and the handler it executes whenever the config is changed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is now a known issue with regards to `fioconfig` and the handler it executes whenever the config is changed. | |
There is now a known issue with regards to ``fioconfig`` and the handler it executes whenever the config is changed. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
rst uses double backticks for literals. Also suggesting some commas. Overall it LGTM.
source/release-notes/rn_v92.inc
Outdated
------------ | ||
|
||
There is now a known issue with regards to `fioconfig` and the handler it executes whenever the config is changed. | ||
The handler in question `aktualizr-toml-update` currently expects a default location for the `sota.toml` file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The handler in question `aktualizr-toml-update` currently expects a default location for the `sota.toml` file. | |
The handler in question, ``aktualizr-toml-update``, currently expects a default location for the ``sota.toml`` file. |
source/release-notes/rn_v92.inc
Outdated
However if the directory that contains the `sota.toml` is changed due to configuration this may result in an error | ||
thrown by the handler stating it cannot find `sota.toml` whenever running a `fioconfig` change. This has been patched |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
However if the directory that contains the `sota.toml` is changed due to configuration this may result in an error | |
thrown by the handler stating it cannot find `sota.toml` whenever running a `fioconfig` change. This has been patched | |
However if the directory that contains the ``sota.toml`` is changed due to configuration, this may result in an error | |
thrown by the handler stating it cannot find ``sota.toml``, whenever running a ``fioconfig`` change. This has been patched |
source/release-notes/rn_v92.inc
Outdated
However if the directory that contains the `sota.toml` is changed due to configuration this may result in an error | ||
thrown by the handler stating it cannot find `sota.toml` whenever running a `fioconfig` change. This has been patched | ||
in the following `commit`_. That patch will ensure the handler from then on uses whichever directory has been configured | ||
to hold the `sota.toml` file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
to hold the `sota.toml` file. | |
to hold the ``sota.toml`` file. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
As we keep a list of known issues on release notes, I think we need an identifier.
Are we publishing the documentation after the tag release?
What identifier should I add for future references? Is there a predetermined format we should use or do we need to come up with one now? 👍 |
Signed-off-by: Eric Bode <[email protected]>
2a046f1
to
4b1e8a8
Compare
Docs for 4b1e8a8 are browsable at: https://ci.foundries.io/projects/fio-docs/builds/2587/docs/artifacts/html/index.html |
Readiness
Overview
Added a known issues text to the release notes concerning the handler logic for
fioconfig
.Checklist
Optional. Add a 'x' to steps taken.
You can fill this out after opening the PR. "Did I..."
make linkcheck
.-s, --signoff
).-S, --gpg-sign
).Comments
Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.