Skip to content
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

Merged
merged 1 commit into from
Feb 2, 2024

Conversation

StealthyCoder
Copy link
Member

Readiness

  • Merge (pending reviews)
  • Merge after date or event
  • Draft

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..."

  • Run spelling and grammar check, preferably with linter.
  • Avoid changing any header associated with a link/reference.
  • Step through instructions (or ask someone to do so).
  • Review for wordiness
  • Match tone and style of page/section.
  • Run make linkcheck.
  • View HTML in a browser to check rendering.
  • Use semantic newlines.
  • follow best practices for commits.
    • Descriptive title written in the imperative.
    • Include brief overview of QA steps taken.
    • Mention any related issues numbers.
    • End message with sign off/DCO line (-s, --signoff).
    • Sign commit with your gpg key (-S, --gpg-sign).
    • Squash commits if needed.
  • Request PR review by a technical writer and at least one peer.

Comments

Any thing else that a maintainer/reviewer should know.
This could include potential issues, rational for approach, etc.

@doanac
Copy link
Member

doanac commented Jan 26, 2024

Known Issues
------------

There is now a known issue with regards to `fioconfig` and the handler it executes whenever the config is changed.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Copy link
Contributor

@kprosise kprosise left a 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.

------------

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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.

Comment on lines 30 to 31
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
to hold the `sota.toml` file.
to hold the ``sota.toml`` file.

Copy link
Collaborator

@angolini angolini left a 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?

@StealthyCoder
Copy link
Member Author

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? 👍

@doanac
Copy link
Member

doanac commented Feb 1, 2024

@kprosise kprosise merged commit cb64ea7 into foundriesio:main Feb 2, 2024
2 of 3 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants