Skip to content

Fix unclear error message regarding the citation of issues in example…#4688

Merged
pascalfleury merged 2 commits into
schemaorg:mainfrom
fthobe:Test-Raise
Jan 15, 2026
Merged

Fix unclear error message regarding the citation of issues in example…#4688
pascalfleury merged 2 commits into
schemaorg:mainfrom
fthobe:Test-Raise

Conversation

@fthobe
Copy link
Copy Markdown
Contributor

@fthobe fthobe commented Jan 14, 2026

… files (#4687)

The previous error message (TYPES does not start with example frag: #{types}) was unclear regarding the requirements of an example file. This commit:

  • references the contribution guidelines
  • raises a more defined error message in github actions

Closes #4687

Error now looks like this:

One or more TYPES do not declare an issue in the example (see https://github.com/schemaorg/schemaorg/blob/main/software/CONTRIBUTING.md): ReserveAction, LinkRole

Example:
Job with failure due to missing issue number on example

Screenshot:
Screenshot 2026-01-15 at 08 30 38

… files (schemaorg#4687)

The previous error message was unclear regarding the requirements of an example file. This commit: 
- references the contribution guidelines
- raises a more defined error message in github actions

Closes schemaorg#4687
@fthobe
Copy link
Copy Markdown
Contributor Author

fthobe commented Jan 14, 2026

@MatthiasWiesmann

Github included the closing bracket inside the link, this commit avoids that to make the link in the error messages clickable.
@fthobe fthobe marked this pull request as ready for review January 15, 2026 08:53
@pascalfleury pascalfleury merged commit dca5e71 into schemaorg:main Jan 15, 2026
1 check passed
@fthobe fthobe deleted the Test-Raise branch January 16, 2026 12:36
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.

Raise more detailed error message if Type of examples does not contain an issue number

3 participants