This pull request aims to merge the Result and ResultOf<T> structs into a single Result<T>, where T is defaulted to Ok. This consolidation eliminates duplication in implementation between Result and ResultOf<T> and simplifies the contents of this package.

This issue recommends using the Gcovr Action in the test.yaml workflow to check the test coverage and assert if the coverage doesn't meet the specified minimum percentage of lines covered.

The proposal is to remove the latest branch, making the main branch the designated latest branch.

Replace the existing usage of res::Err with error::Error from the Error Package in the threeal/cpp repository. This update ensures consistent usage of error handling throughout the codebase.

To prevent the result::Result class from being discarded when it is returned from a function, add the nodiscard attribute to the class.

This attribute will emit a warning if the return value of a function returning result::Result is not used, reminding the user to handle the result appropriately.

This issue recommends modifying the documentation hosting to utilize GitHub Pages, replacing the currently used Read the Docs platform.

GitHub Pages is preferred because we will have more control over how to setup and deploy the documentation.

This issue suggests modifying the build and test workflows to use the default compiler and generator instead of specifying custom ones. To set the default, one can simply remove the generator and cxx-compiler inputs from steps that utilize the CMake Action.

This issue proposes the elimination of the step to send the test coverage report to Coveralls. The suggested change is based on the belief that sending the coverage report to Coveralls is unnecessary. Typically, it is preferable to assert if the test coverage does not reach a specific threshold, as demonstrated in the check coverage step of the C++ Starter template.

This issue recommends incorporating the CheckWarning.cmake module to examine compiler warnings in the project, thus replacing the manual configuration of the CMAKE_CXX_FLAGS variable. With the adoption of this module, it is conceivable that the check warning jobs in the test.yml workflow may no longer be necessary, as warnings will consistently be assessed during the build process.

Introduce a workflow in the GitHub actions to build the documentation. This workflow includes a job that tests the successful building of the documentation.

Modify the Result class to store the value and error separately, enabling extraction using structured binding declaration as shown in the following example:

result::Result<Image> load_image(const std::filesystem::path& path);

int main() {
  const auto [image, error] = load_image(image_path);
  if (error) {
    // Handle the error case.
  } else {
    // Do something with the image.
  }
}

• Generate an API documentation using Doxygen
• Convert that API documentation to web pages using Sphinx in a Read the Docs style.
• Deploy those pages as a Read the Docs site.

This issue suggests simplifying the content of the CPM.cmake file, following the content which is implemented by Errors C++ as in threeal/errors-cpp#114.

This issue identifies this failing build on the latest master, which appears to be caused by incorrect usage of the Gcov executable when calling the Gcovr Action.

Since #87, the test workflow is no longer built using llvm, but the Gcovr Action is still utilizing the LLVM version of the Gcov executable. This mismatch has resulted in a failing build since the merging of #88.

This issue recommends reverting the Gcov executable back to using the default executable.

This issue suggests eliminating the process of sending test results to Testspace in the test workflow. We are discontinuing the use of Testspace as monitoring test results is deemed unnecessary; any test failures should be evident in the CI log. Furthermore, anything merged into the main branch is considered to have passed testing.

This issue proposes disabling CMake formatting, introduced through the Format.cmake package, by setting the FORMAT_SKIP_CMAKE option to ON. See threeal/cpp-starter#73 for the rationale behind this proposal.

This issue suggests removing badges from the README.md file because the information in the badges does not seem to be important to include in the readme. Refer to threeal/pipx-install-action#119 for more information and the rationale behind this proposal.