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

Releases 10.6.0 and 10.7.0 contain invalid #include line #170

Closed
claremacrae opened this issue Feb 9, 2021 · 1 comment
Closed

Releases 10.6.0 and 10.7.0 contain invalid #include line #170

claremacrae opened this issue Feb 9, 2021 · 1 comment

Comments

@claremacrae
Copy link
Collaborator

The problem code is this:

// ******************** From: FrameworkIntegrations.h

#include <ApprovalTests.hpp>

namespace ApprovalTests
{
    class FrameworkIntegrations
    {
    public:
        static void
        setTestPassedNotification(FileApprover::TestPassedNotification notification);

        static void setCurrentTest(ApprovalTests::TestName* currentTest);
    };
}

I saw it via this build error, when using the single-header file:

error: 'ApprovalTests.hpp' file not found with <angled> include; use "quotes" instead
#include <ApprovalTests.hpp>
         ^~~~~~~~~~~~~~~~~~~
         "ApprovalTests.hpp"
1 error generated.

It's wrong at several levels:

  • We shouldn't include any of our own header files via <...>, as they will be presumed to be system headers, and not processed correctly by our release script.
  • We also shouldn't include the simulated single header file - ApprovalTests.hpp - in any of the library headers, as it will end up #including itself in the final released header
claremacrae added a commit that referenced this issue Feb 9, 2021
This is in preparation for adding validation to prevent recurrence of #170
claremacrae added a commit that referenced this issue Feb 9, 2021
These get added by CLion refactoring, and they break our release process.
This should prevent recurrences of #170
@claremacrae
Copy link
Collaborator Author

This was fixed in the 10.7.1 release.

@claremacrae claremacrae pinned this issue Feb 9, 2021
@claremacrae claremacrae unpinned this issue Sep 15, 2021
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

No branches or pull requests

1 participant