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

🚧Add ability to download release assests #56

Merged
merged 23 commits into from
May 15, 2024

Conversation

CalvinWilkinson
Copy link
Member

@CalvinWilkinson CalvinWilkinson commented May 14, 2024

Description:

To allow this pull request to be merged, please make sure that the following items of this pull request are complete.

This pull request closes #53

✅The pull request head branch must be a feature branch with the syntax 'feature/-sync-testing'.
✅The pull request base branch must be a 'main' or 'preview' branch..
✅The pull request head branch contains a valid issue number.
✅The pull request title matches the linked issue title exactly.
✅The pull request assignees match the assignees of the issue.
✅The pull request labels match the labels of the issue.
✅The pull request organizational projects match the organizational projects of the issue.
✅The pull requests milestone matches the milestone of the issue.


Additional Info:

  1. Pull requests are automatically synced with the associated issue upon creation by one of the KinsonDigital workflow bots.
  2. The associated issue is the issue number that is embedded in the pull request head branch.
  3. The list above will be automatically updated as the pull request's various settings match or do not match the associated issue.
  4. To manually sync the pull request to the issue, create a comment with the [run-sync] command.

    Note You must be an admin member of the organization to use this command.


  • Sync with the issue. Use this to enable or disable this pull request from syncing with its associated issue.

@CalvinWilkinson CalvinWilkinson added this to the v1.0.0-preview.10 milestone May 14, 2024
@CalvinWilkinson CalvinWilkinson changed the title new pr 🚧Add ability to download release assests May 14, 2024
@CalvinWilkinson CalvinWilkinson added medium-priority Medium Priority preview Done while in preview ✨new-feature New feature that does not exist labels May 14, 2024
@CalvinWilkinson CalvinWilkinson self-assigned this May 14, 2024
@CalvinWilkinson
Copy link
Member Author

CalvinWilkinson commented May 14, 2024

Note

Added the following https://github.com/KinsonDigital/kd_clients/labels/%E2%9C%A8new%20feature 's

  1. Added a new data model named AssetModel to represent a release asset.
  2. Added a new property named assets to the ReleaseModel type
  3. Added a new function named getReleaseById to the ReleaseClient to get a release by a release id.
  4. Added a new function named getReleaseByTag to the ReleaseClient to get a release by a release tag.
  5. Added a new function named getAllAssetsByTag to the ReleaseClient to get all assets of a release by tag name
  6. Added a new function named getAsset to the ReleaseClient to get a single asset from a release using the following parameters:
    • release id or tag
    • asset id or name
  7. Added a new function named getReleaseByName to the ReleaseClient to return a release that matches a name.
  8. Added a new function named uploadAssetsByReleaseName to the ReleaseClient to upload assets to a release that matches a name.
  9. Added a new function named uploadAssetsByReleaseTag to the ReleaseClient to upload assets to a release that matches a tag.
  10. Added a new function named downloadAssetById to the ReleaseClient to download a single asset using an asset id
  11. Added a new function named downloadAllAssetsByReleaseName to the ReleaseClient for downloading all release assets by release name.
  12. Added a new function named downloadAllAssetsByReleaseTag to the ReleaseClient for downloading all release assets by release tag.
  13. Added a new function named getLatestRelease to the ReleaseClient for getting the latest release.

@CalvinWilkinson CalvinWilkinson added the 🧨breaking-changes Feature/changes contains breaking changes label May 14, 2024
@CalvinWilkinson
Copy link
Member Author

CalvinWilkinson commented May 14, 2024

Warning

Introduced the following https://github.com/KinsonDigital/kd_clients/labels/%F0%9F%A7%A8breaking%20changes

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

@CalvinWilkinson CalvinWilkinson marked this pull request as ready for review May 15, 2024 08:20
@CalvinWilkinson CalvinWilkinson merged commit 1d56e40 into preview May 15, 2024
5 checks passed
@CalvinWilkinson CalvinWilkinson deleted the feature/53-add-download-assets branch May 15, 2024 08:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🧨breaking-changes Feature/changes contains breaking changes medium-priority Medium Priority ✨new-feature New feature that does not exist preview Done while in preview
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

🚧Add ability to download release assests
2 participants