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

[SWT-0001] Dedicated .bug() functions for URLs and IDs #412

Merged
merged 4 commits into from
May 24, 2024

Conversation

grynspan
Copy link
Contributor

@grynspan grynspan commented May 14, 2024

One of the features of swift-testing is a test traits system that allows associating metadata with a test suite or test function. One trait in particular, .bug(), has the potential for integration with development tools but needs some refinement before integration would be practical.

Read the full proposal here.

Checklist:

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

One of the features of swift-testing is a test traits system that allows
associating metadata with a test suite or test function. One trait in
particular, `.bug()`, has the potential for integration with development tools
but needs some refinement before integration would be practical.

Read the full proposal [here]().
@grynspan grynspan added public-api Affects public API api-proposal API proposal PRs (documentation only) labels May 14, 2024
@grynspan grynspan self-assigned this May 14, 2024
@grynspan grynspan changed the title Dedicated .bug() functions for URLs and IDs [API Proposal] Dedicated .bug() functions for URLs and IDs May 14, 2024
@Uncommon
Copy link

Full proposal link goes right back to this page.

@grynspan
Copy link
Contributor Author

grynspan commented May 14, 2024

Oops. Fixed.

@grynspan grynspan changed the title [API Proposal] Dedicated .bug() functions for URLs and IDs [SWT-NNNN] Dedicated .bug() functions for URLs and IDs May 15, 2024
grynspan added a commit that referenced this pull request May 16, 2024
…oposed new layout.

We're proposing a new set of stored properties for `Bug` in #412. This new
layout is incompatible with the old one when using `Codable`. This change adds a
(very!) temporary workaround to ensure that bugs encoded with the current layout
can be decoded with the new one once it is accepted and merged in.
grynspan added a commit that referenced this pull request May 16, 2024
…oposed new layout. (#419)

We're proposing a new set of stored properties for `Bug` in #412. This
new layout is incompatible with the old one when using `Codable`. This
change adds a (very!) temporary workaround to ensure that bugs encoded
with the current layout can be decoded with the new one once it is
accepted and merged in.

This implementation can be removed when #412 is merged.

### Checklist:

- [x] Code and documentation should follow the style of the [Style
Guide](https://github.com/apple/swift-testing/blob/main/Documentation/StyleGuide.md).
- [x] If public symbols are renamed or modified, DocC references should
be updated.
@grynspan grynspan changed the title [SWT-NNNN] Dedicated .bug() functions for URLs and IDs [SWT-0001] Dedicated .bug() functions for URLs and IDs May 24, 2024
@grynspan
Copy link
Contributor Author

Documentation only, skipping CI.

@grynspan grynspan merged commit 2ccdc81 into main May 24, 2024
@grynspan grynspan deleted the jgrynspan/refactor-bug-inits-proposal branch May 24, 2024 19:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api-proposal API proposal PRs (documentation only) public-api Affects public API
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants