Skip to content

🚀Preview Release - v1.0.0-preview.10

Pre-release
Pre-release
Compare
Choose a tag to compare
@github-actions github-actions released this 15 May 11:50
· 24 commits to preview since this release

kd_clients Preview Release Notes - v1.0.0-preview.10

Quick Reminder

As with all software, there is always a chance for issues and bugs, especially for preview releases, so your input is greatly appreciated. 🙏🏼

New Features ✨

  1. #9 - Added an error type named AuthError.

  2. #53 - Added a new data model named AssetModel to represent a release asset.

  3. #53 - Added a new property named assets to the ReleaseModel.type.

  4. #53 - Added the following functionality to the ReleaseClient:

    • A new function named getReleaseById was added to get a release using a release ID.
    • A new function named getReleaseByTag was added to get a release using a release tag.
    • A new function named getAllAssetsByTag was added to get all release assets using a release tag name.
    • A new function named getAsset was added to get a single asset from a release using a combination of the release ID or tag and the asset ID or tag.
    • A new function named getReleaseByName was added to return a release that matches a release name.
    • A new function named uploadAssetsByReleaseName was added to upload assets to a release that matches a release name.
    • A new function named uploadAssetsByReleaseTag was added to upload assets to a release that matches a release tag.
    • A new function named downloadAssetById was added to download a single asset using an asset ID.
    • A new function named downloadAllAssetsByReleaseName was added to download all release assets using a release name.
    • A new function named downloadAllAssetsByReleaseTag was added to download all release assets using a release tag.
    • A new function named getLatestRelease was added to get the latest release.

Enhancements ✨

  1. #9 - Updated all clients to check for authentication issues.
    • These will now throw an AuthError if authentication has failed.

Breaking Changes 🧨

  1. #9 - Introduced the following breaking changes:

    • Changed the name of the 'toReleaseBy' parameter to tagOrTitle for the uploadAssets() function in the ReleaseClient class.
    • Moved the XError type from the GitHubClients.Errors.mod.ts file to the OtherClients.Errors.mod.ts file.
    • Moved the NuGetError type from the GitHubClients.Errors.mod.ts file to the PackageClients.Errors.mod.ts file.
    • Refactored the getPullRequests() function return type from Promise<[PullRequestModel[], Response]> to Promise<PullRequestModel[]> in the PullRequestClient class.
    • Refactored the getIssues() function return type from Promise<[IssueModel[], Response]> to Promise<IssueModel[]> in the IssueClient class.
    • Refactored the getOwnerRepos() function return type from Promise<[RepoModel[], Response]> to Promise<RepoModel[]> in the RepoClient class.
    • Changed the name of the getOwnerRepos() function to getAllRepos().
    • Refactored the getTags() function return type from Promise<[TagModel[], Response]> to Promise<TagModel[]> in the TagClient class.
    • Refactored the getWorkflowRuns() function return type from Promise<[WorkflowRunModel[], Response]> to Promise<WorkflowRunModel[]> in the WorkflowClient class.
  2. #53 - Introduced the following breaking changes:

    • Removed the getRelease function from the ReleaseClient.
         - This has been replaced by the new function named getReleaseByName.
    • Removed the uploadAssets function from the ReleaseClient.
         - The uploadAssetsByReleaseName function has replaced this.
    • The GitHub token parameter for the ReleaseClient was changed from optional to required.
    • Removed the ReleaseOptions interface.

Dependency Updates 📦

  1. #58 - Updated the following deno standard modules:
    • Updated exists from 0.203.0 to 0.224.0
    • Updated extname from 0.203.0 to 0.224.0
    • Updated existsSync from 0.203.0 to 0.224.0
    • Updated walkSync from 0.203.0 to 0.224.0
    • Updated ensureDirSync from 0.203.0 to 0.224.0
    • Updated basename from 0.203.0 to 0.224.0
    • Updated isAbsolute from 0.203.0 to 0.224.0
    • Updated decodeBase64 from 0.203.0 to 0.224.0
    • Updated encodeBase64 from 0.203.0 to 0.224.0
    • Updated assert form 0.204.0 to 0.224.0
    • Updated assertEquals form 0.204.0 to 0.224.0
    • Updated assertThrows form 0.204.0 to 0.224.0
    • Updated assertRejects form 0.204.0 to 0.224.0
    • Updated equal form 0.204.0 to 0.224.0
    • Updated assertSpyCall form 0.204.0 to 0.224.0
    • Updated assertSpyCalls form 0.204.0 to 0.224.0
    • Updated spy form 0.204.0 to 0.224.0
    • Updated stub form 0.204.0 to 0.224.0
    • Updated returnsNext form 0.204.0 to 0.224.0
    • Updated returnsArg form 0.204.0 to 0.224.0

Other 🪧

  1. #51 - Fixed an issue with the release process regarding sending release tweets.
  2. #40 - Fixed an issue in the release process to properly close milestones.