Skip to content

Introduce a severity level when recording issues #1070

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

Conversation

suzannaratcliff
Copy link
Contributor

@suzannaratcliff suzannaratcliff commented Apr 10, 2025

Introduce a severity level when recording issues

Motivation:

In order to create issues that don't fail a test this introduces a parameter to specify the severity of the issue. This is in support of work added here for an issue severity: #931

This is experimental.

Example usage:
Issue.record("My comment", severity: .warning)

Modifications:

I modified the Issue.record method signature to take in a severity level so that users can create issues that are not failing.

Checklist:

  • Code and documentation should follow the style of the Style Guide.
  • If public symbols are renamed or modified, DocC references should be updated.
  • Add tests

@stmontgomery stmontgomery added the enhancement New feature or request label Apr 10, 2025
@stmontgomery stmontgomery added this to the Swift 6.x milestone Apr 10, 2025
@stmontgomery stmontgomery added the issue-handling Related to Issue handling within the testing library label Apr 10, 2025
@grynspan grynspan added the public-api Affects public API label Apr 10, 2025
@stmontgomery
Copy link
Contributor

This is a good start. Please do add tests which call this new overload!

@suzannaratcliff
Copy link
Contributor Author

@swift-ci please test

@suzannaratcliff
Copy link
Contributor Author

@swift-ci please test

@suzannaratcliff suzannaratcliff merged commit d8d20a5 into swiftlang:main Apr 10, 2025
3 checks passed
@stmontgomery stmontgomery modified the milestones: Swift 6.x, Swift 6.2 Apr 24, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request issue-handling Related to Issue handling within the testing library public-api Affects public API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants