Releases: KinsonDigital/kd_clients
🚀Preview Release - v1.0.0-preview.14
kd_clients Preview Release Notes - v1.0.0-preview.14
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 ✨
- #85 - Added a new function with the name
getAllBranches()
to theGitClient
class that returns all git branches. - #83 - Added a new function named
getAllReleases()
theReleaseClient
class.- This will return all releases for a GitHub repository.
- #78 - Added the following functions to update a release in the
ReleaseClient
class.updateReleaseById()
updateReleaseByTag()
Enhancements 💎
- #82 - Created a new type with the name
State
to represent the state of an issue or pull request. Updated thestate
property type to this new type in theIssueModel
andPullRequestModel
types.
Bug Fixes 🐛
- #91 - Fixed a bug where the
fileExists()
function in theRepoClient
class was reporting the incorrect result.
Breaking Changes 🧨
- #84 - Refactored parameters with the name
branchName
toref
in the following functions in theRepoClient
class:getFileContent()
fileExists()
- #77 - Introduced the following breaking changes by renaming the functions below:
- Renamed the function
milestoneExists()
toexists
in theMilestoneClient
class - Renamed the function
labelExists()
toexists
in theLabelClient
class - Renamed the function
pullRequestExists()
toexists
in thePullRequestClient
class - Renamed the function
openPullRequestExists()
toopenExists
in thePullRequestClient
class - Renamed the function
closedPullRequestExists()
toclosedExists
in thePullRequestClient
class - Renamed the function
issueExists()
toexists
in theIssueClient
class - Renamed the function
openIssueExists()
toopenExists
in theIssueClient
class - Renamed the function
closedIssueExists()
toclosedExists
in theIssueClient
class - Renamed the function
repoVariableExists()
tovariableExists
in theRepoClient
class - Renamed the function
tagExists()
toexists
in theTagClient
class - Renamed the function
packageWithVersionExists()
toexists
in theNuGetClient
class - Removed the
packageExists()
function in theNuGetClient
class - Changed the
exists()
function parameterversion
to an optional parameter in theNuGetClient
class
- Renamed the function
Dependency Updates 📦
Technical Debt 🧽
- #77 - Renamed client functions to simplify and reduce verbosity of API.
Configuration 🛠️
🚀Preview Release - v1.0.0-preview.13
kd_clients Preview Release Notes - v1.0.0-preview.13
Quick Reminder
As with all software, there is always a chance for issues and bugs, especially for preview releases, which is why your input is greatly appreciated. 🙏🏼
Bug Fixes 🐛
- #74 - Fixed a bug with getting issues when filtering with labels.
🚀Preview Release - v1.0.0-preview.12
kd_clients Preview Release Notes - v1.0.0-preview.12
Quick Reminder
As with all software, there is always a chance for issues and bugs, especially for preview releases, which is why your input is greatly appreciated. 🙏🏼
Bug Fixes 🐛
- #69 - Fixed an issue where getting assets with the
ReleaseClient
after downloading assets with theReleaseClient
would cause an error with incorrect media types.
🚀Preview Release - v1.0.0-preview.11
kd_clients Preview Release Notes - v1.0.0-preview.11
Quick Reminder
As with all software, there is always a chance for issues and bugs, especially for preview releases, which is why your input is greatly appreciated. 🙏🏼
New Features ✨
- #65 - Added the following functions to the
ReleaseClient
:- Added the function named
assetExists
to check if a single release asset exists. - Added the function named
deleteAsset
to delete a single asset from a release. - Added the function named
uploadAsset
to upload a single asset to a release.
- Added the function named
Breaking Changes 🧨
- #65 - Introduced the following breaking changes:
- Changed the parameter type for the
uploadAssetsByReleaseName
functionfilePaths
fromstring | string[]
tostring[]
. - Changed the parameter type for the
uploadAssetsByReleaseTag
functionfilePaths
fromstring | string[]
tostring[]
.
- Changed the parameter type for the
Other 🪧
- #63 - Improved release process.
🚀Preview Release - v1.0.0-preview.10
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 ✨
-
#9 - Added an error type named
AuthError
. -
#53 - Added a new data model named
AssetModel
to represent a release asset. -
#53 - Added a new property named
assets
to theReleaseModel
.type. -
#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.
- A new function named
Enhancements ✨
- #9 - Updated all clients to check for authentication issues.
- These will now throw an
AuthError
if authentication has failed.
- These will now throw an
Breaking Changes 🧨
-
#9 - Introduced the following breaking changes:
- Changed the name of the 'toReleaseBy' parameter to
tagOrTitle
for theuploadAssets()
function in theReleaseClient
class. - Moved the
XError
type from theGitHubClients.Errors.mod.ts
file to theOtherClients.Errors.mod.ts
file. - Moved the
NuGetError
type from theGitHubClients.Errors.mod.ts
file to thePackageClients.Errors.mod.ts
file. - Refactored the
getPullRequests()
function return type fromPromise<[PullRequestModel[], Response]>
toPromise<PullRequestModel[]>
in thePullRequestClient
class. - Refactored the
getIssues()
function return type fromPromise<[IssueModel[], Response]>
toPromise<IssueModel[]>
in theIssueClient
class. - Refactored the
getOwnerRepos()
function return type fromPromise<[RepoModel[], Response]>
toPromise<RepoModel[]>
in theRepoClient
class. - Changed the name of the
getOwnerRepos()
function togetAllRepos()
. - Refactored the
getTags()
function return type fromPromise<[TagModel[], Response]>
toPromise<TagModel[]>
in theTagClient
class. - Refactored the
getWorkflowRuns()
function return type fromPromise<[WorkflowRunModel[], Response]>
toPromise<WorkflowRunModel[]>
in theWorkflowClient
class.
- Changed the name of the 'toReleaseBy' parameter to
-
#53 - Introduced the following breaking changes:
- Removed the
getRelease
function from theReleaseClient
.
- This has been replaced by the new function namedgetReleaseByName
. - Removed the
uploadAssets
function from theReleaseClient
.
- TheuploadAssetsByReleaseName
function has replaced this. - The GitHub token parameter for the
ReleaseClient
was changed from optional to required. - Removed the
ReleaseOptions
interface.
- Removed the
Dependency Updates 📦
- #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 🪧
🚀Preview Release - v1.0.0-preview.9
kd_clients Preview Release Notes - v1.0.0-preview.9
Quick Reminder
As with all software, there is always a chance for issues and bugs, especially for preview releases, which is why your input is greatly appreciated. 🙏🏼
Dependency Updates 📦
- #44 - Updated softprops/action-gh-release action to v2.0.0
- #41 - Updated kinsondigital/infrastructure action to v13.6.3
Other 🪧
🚀Preview Release - v1.0.0-preview.8
kd_clients Preview Release Notes - v1.0.0-preview.8
Quick Reminder
As with all software, there is always a chance for issues and bugs, especially for preview releases, which is why your input is greatly appreciated. 🙏🏼
Bug Fixes 🐛
- #35 - Fixed an issue with the
NuGetClient
class where thegetPackageVersions
andpackageWithVersionExists
functions were not working correctly.
Dependency Updates 📦
- #34 - Updated kinsondigital/infrastructure action to v13.6.0
Other 🪧
🚀Preview Release - v1.0.0-preview.7
kd_clients Preview Release Notes - v1.0.0-preview.7
Quick Reminder
As with all software, there is always a chance for issues and bugs, especially for preview releases, which is why your input is greatly appreciated. 🙏🏼
Bug Fixes 🐛
- #28 - Fixed a bug where getting the repository using the
RepoClient.getRepo()
function only worked with all lowercase repo names.
🚀Preview Release - v1.0.0-preview.6
kd_clients Preview Release Notes - v1.0.0-preview.6
Quick Reminder
As with all software, there is always a chance for issues and bugs, especially for preview releases, which is why your input is greatly appreciated. 🙏🏼
New Features ✨
- #27 - Added the following functions to all GitHub HTTP clients to manage headers.
getHeader()
updateOrAdd()
clearHeaders()
containsHeader()
- #22 - Added the ability to upload assets to a GitHub release.
- The new function named
uploadAssets
was added to theReleaseClient
class.
- The new function named
Breaking Changes 🧨
- #22 - Removed the functions
getReleaseByTag
andgetReleaseByName
.- These functions were replaced by the function named
getRelease
. - The
getRelease
function now uses the options parameter namedReleaseOptions
.
- These functions were replaced by the function named
- #19 - Changed the
token
constructor parameter of theOrgClient
class from optional to required.
Bug Fixes 🐛
- #27 - Fixed a bug where attempting to update a file in a repository where the file already exists throws an error saying that it already exists.
🚀Preview Release - v1.0.0-preview.5
kd_clients Preview Release Notes - v1.0.0-preview.5
Quick Reminder
As with all software, there is always a chance for issues and bugs, especially for preview releases, which is why your input is greatly appreciated. 🙏🏼
Bug Fixes 🐛
- #15 - Fixed create org client issue.