Skip to content

CHANGELOG.md

Latest commit

 

History

History
152 lines (100 loc) · 7.01 KB

CHANGELOG.md

File metadata and controls

152 lines (100 loc) · 7.01 KB

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Nothing yet.

0.3.3 (2024-04-29)

  • Fix: Decoding of issue labels previously failed in the TypedDecoder plugin.

0.3.2 (2024-04-25)

  • Add: Add shared: true option to several testing-related calls to enable shared storage of mocks and calls across process boundaries. See the Async and Sharing section of the GitHub.Testing module documentation.
  • Fix: Remove empty schemas that represented open map types.

0.3.1 (2024-03-26)

  • Add: Add cache: false option to mock_gh/3 to disable result caching during testing.
  • Fix: Always return pull: true in generated repository permissions during testing.

0.3.0 (2024-03-08)

  • Breaking: Thanks to advancements in the code generator (now using 0.1.0-rc.4), the majority of responses and subfields are now correctly decoded. When appropriate, some operations will have atom-keyed maps as return types.

0.2.3 (2023-12-11)

  • Fix: Resolve issue with the contract of GitHub.Webhook.body_reader/1 and the underlying reader function.

0.2.2 (2023-12-11)

  • Add: Create GitHub.Auth implementation for GitHub.App structs.
  • Add: Cache GitHub App JWTs using GitHub.Auth.Cache if started in the application supervisor.
  • Add: Helper GitHub.app/1 to create a basic app struct for use with authentication.
  • Add: Test helper GitHub.Testing.to_gh_params/1 to take generated data and create string maps.

0.2.1 (2023-12-11)

  • Add: Add decode/2 to Typed Decoder plugin for manually decoding data in test environments.

0.2.0 (2023-12-10)

  • Add: Add GitHub.Webhook with helpers for handling webhook requests in a plug application.

0.1.1 (2023-10-04)

  • Fix: Test data created with the GitHub.Testing module incorrectly returned ISO 8601 strings for date/time fields.

0.1.0 (2023-09-29)

This version marks a higher level of stability for the library, though it is still pre-release software.

  • Breaking: Regenerate code for description at commit ffaf232.
  • Add: Telemetry events for all operation calls. See the telemetry guide for more information.
  • Add: OpenTelemetry plugin for easy integration with existing telemetry events.
  • Add: Now using 0.1.0-rc.3 of the generator.

0.0.13 (2023-09-12)

  • Fix: Correctly decode false values from responses. Previously, these values were replaced with nil.

0.0.12 (2023-05-18)

  • Fix: Support generating empty responses in test data generator.

0.0.11 (2023-05-18)

  • Add: Improvements to the test data generator. Repositories now always have created_at dates despite their typing, and Pull Requests have proper base and head maps.

0.0.10 (2023-05-18)

  • Add: New __info__ key on every struct to contain library and plugin data.
  • Add: Preserve important response headers in GitHub.Plugin.RedixFullResponseCache.

0.0.9 (2023-05-17)

  • Add: Generated data from GitHub.Testing.generate_gh/3 now accepts optional overrides.
  • Fix: Include formatter configuration in published package. This allows use of mock_gh and other imported test helpers without parens.

0.0.8 (2023-05-16)

  • Fix: Correctly generate array types using single element lists in GitHub.Testing.

0.0.7 (2023-05-16)

  • Add: Support lists of servers in both Redix-based plugins.
  • Add: Correctly decode repository rule unions in GitHub.Plugin.TypedDecoder.
  • Fix: Correctly decode array types in GitHub.Plugin.TypedDecoder.

0.0.6 (2023-05-16)

  • Breaking: Perform major housecleaning on module naming, groups, etc. Most notable is the merging of Team.Full to Team and MinimalRepository to Repository. Several schemas have been placed into better groups, and some have been moved (for example, Job is now Actions.Job). Not all changes are documented here because this library is in early beta and this type of movement is expected.
  • Breaking: Update to the latest version of the API description, which removes several operations and adds several schemas.
  • Add: Simplified generate_gh/2 helper in GitHub.Testing for generating structs.
  • Add: Upgrade to oapi_generator version 0.0.5 with support for null unions, as found in the latest API description.

0.0.5 (2023-05-12)

  • Breaking: GitHub.Plugin.TypedDecoder now normalizes errors for all status codes greater than or equal to 400. Previously, errors were only normalized when the operation had well-typed errors in its response specification. This left out a large number of errors, including many "Not Found" errors that did not need to be documented for every operation. For a list of supported errors, see GitHub.Error.
  • Add: GitHub.Error structs now have an easily matchable reason field. This field will need to be populated on a case-by-case basis in GitHub.Plugin.TypedDecoder.
  • Fix: Return valid user type values from the test generator.

0.0.4 (2023-05-12)

  • Breaking: The mock system has been rewritten to allow greater flexibility. See GitHub.Testing for more information.
  • Add: Add helper GitHub.Operation.get_options/1 for plugins and testing.
  • Fix: Export "locals without parens" to allow using test helpers without parentheses.

0.0.3 (2023-05-11)

  • Add: Decode union types in GitHub.Plugin.TypedDecoder using best-guess logic. This enhancement supports all currently-known union type responses, but it will require long-term maintenance.

  • Add: Allow returning unwrapped results from client operations. This can be useful for callers that need more information, such as response headers.

  • Fix: Support zero-arity operations in GitHub.Operation.get_caller/1.

0.0.2 (2023-05-11)

  • Breaking: Upgrade to OpenAPI 3.1 description (descriptions-next) with better support for nullable fields. No more .nullable() types!
  • Add: Upgrade to oapi_generator version 0.0.2, with support for OpenAPI 3.1 and other fixes.
  • Add: Upgrade to oapi_generator version 0.0.3, with support for args passed to the client.
  • Add: Upgrade to oapi_generator version 0.0.4, with support for call passed to the client.
  • Add: Include the recommended API version header in all requests. The value of this header is defined by the .api-version file, which should be kept up-to-date as the code is regenerated.
  • Add: Plugin for caching redirect locations to avoid repeated (rate limited) 301 responses.
  • Add: Test helpers in GitHub.Testing and corresponding plugin GitHub.Plugins.TestClient.
  • Add: Allow setting the client stack at runtime.

0.0.1 (2023-01-05)

  • Initial Release