Skip to content

feat: use new config model #357

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

Merged
merged 33 commits into from
Jul 24, 2024
Merged

feat: use new config model #357

merged 33 commits into from
Jul 24, 2024

Conversation

alinarublea
Copy link
Contributor

Please ensure your pull request adheres to the following guidelines:

  • make sure to link the related issues in this description. Or if there's no issue created, make sure you
    describe here the problem you're solving.
  • when merging / squashing, make sure the fixed issue references are visible in the commits, for easy compilation of release notes

If the PR is changing the API specification:

  • make sure you add a "Not implemented yet" note the endpoint description, if the implementation is not ready
    yet. Ideally, return a 501 status code with a message explaining the feature is not implemented yet.
  • make sure you add at least one example of the request and response.

If the PR is changing the API implementation or an entity exposed through the API:

  • make sure you update the API specification and the examples to reflect the changes.

Related Issues

Thanks for contributing!

Copy link

This PR will trigger a minor release when merged.

@alinarublea alinarublea marked this pull request as draft June 14, 2024 13:17
Copy link
Contributor

@iuliag iuliag left a comment

Choose a reason for hiding this comment

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

Looks good so far!
You'd need to update the API spec as well, around the site config/org config.

@@ -53,7 +51,7 @@ async function getSitesToAudit(dataAccess, url, deliveryType, orgs) {
const site = await dataAccess.getSiteByBaseURL(url);
sitesToAudit = site ? [site] : [];
}
return sitesToAudit.filter((site) => !isAuditsDisabled(site, orgs[site.getOrganizationId()]));
return sitesToAudit;
Copy link
Contributor

Choose a reason for hiding this comment

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

The js doc needs to be updated, because in the new version we don't have a flag to disable all handler types for a site.

@alinarublea alinarublea marked this pull request as ready for review July 3, 2024 14:29
Copy link
Contributor

@iuliag iuliag left a comment

Choose a reason for hiding this comment

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

Nice!

alerts:
- type: '404'
byOrg: true
handlers:
Copy link
Contributor

Choose a reason for hiding this comment

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

We can start reusing examples, when they become repetitive: https://swagger.io/docs/specification/adding-examples/ -> Reusing Examples

description: The Slack mentions to include in the alert
$ref: '#/SlackMentionConfig'
excludedURLs:
description: URLs to be excluded from the alert
Copy link
Contributor

Choose a reason for hiding this comment

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

nitpicking: URLs to be excluded from the handler's processing?

Copy link
Contributor

Choose a reason for hiding this comment

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

Would manualOverwrites, fixedURLs from broken-backlinks need to be added here as well or would they be allowed under broken-backlinks key?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I will add them as well

Copy link
Contributor

Choose a reason for hiding this comment

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

@alinarublea would this cover the manualOverwrites doc from #387 ? Or can I update the PR after this one is merged?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes, it s exactly that, I wont modify it then and I will let you know after I merge

@alinarublea alinarublea merged commit fcd15a5 into main Jul 24, 2024
4 checks passed
@alinarublea alinarublea deleted the issue-115-2 branch July 24, 2024 09:23
@solaris007
Copy link
Member

🎉 This issue has been resolved in version 1.56.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants