Skip to content

fix(schemas): remove 'email' format for 'email' property in committer.schema.json #678

New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Merged
merged 2 commits into from
Jul 21, 2022

Conversation

oscard0m
Copy link
Member

Description

  • Remove format: email for "email" property in committer.schema.json
  • Added a new schema example to validate emails with special characters are validated
  • Regenerate index.json

Context

emails aren't compliant with the RFC, not because of anything related to the JSON schema itself.

RFC 5322 Section 3.4 defines valid email addresses here: https://datatracker.ietf.org/doc/html/rfc5322#section-3.4

Example of not supported format:
41898282+github-actions[bot]@users.noreply.github.com

Fixes #453

Alternative solutions

To use the existing pattern from ajv-format for email and cover the use-case of emails. (#677)

Discussion on-going in #453

@oscard0m oscard0m added the Type: Bug Something isn't working as documented label Jul 21, 2022
@oscard0m oscard0m force-pushed the disable-format-for-email-in-commit-schema branch from a609bd1 to badef53 Compare July 21, 2022 08:11
@wolfy1339 wolfy1339 merged commit e410fa0 into master Jul 21, 2022
@wolfy1339 wolfy1339 deleted the disable-format-for-email-in-commit-schema branch July 21, 2022 10:17
@octokitbot
Copy link
Contributor

🎉 This PR is included in version 6.2.4 🎉

The release is available on:

Your semantic-release bot 📦🚀

# for free to join this conversation on GitHub. Already have an account? # to comment
Labels
Type: Bug Something isn't working as documented
Projects
None yet
Development

Successfully merging this pull request may close these issues.

false-positives when validating webhooks payloads due to email addresses
3 participants