Skip to content

Introduce Download Ability #35

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.

Sign up for GitHub

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

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open

Introduce Download Ability #35

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
ec60031
feat(download): download asset after it's upload
Kuuzoo Mar 29, 2025
bc20c46
fix(download): add param to action & build
Kuuzoo Mar 29, 2025
18de724
refactor(action): rename zipPath to uploadPath and update documentation
Kuuzoo Apr 6, 2025
3d462ec
refactor(upload): rename zipPath to uploadPath and update related fun…
Kuuzoo Apr 6, 2025
648532f
chore(rebuild): update typings and resolve lint warnings
Kuuzoo Apr 6, 2025
443127f
fix(asset): handle invalid asset state with error messages
Kuuzoo Apr 12, 2025
259fbaf
chore(rebuild): handle invalid asset state
Kuuzoo Apr 12, 2025
e45900f
fix(asset): add logging for submitted asset state during readiness check
Kuuzoo Apr 17, 2025
4eb8125
chore(rebuild): handle submitted asset state
Kuuzoo Apr 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,5 @@ jobs:
uses: ./
with:
cookie: ${{ secrets.FORUM_COOKIE }}
zipPath: ./test.zip
uploadPath: ./test.zip
assetId: 489345
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ CFX provides API keys for this action.
| makeZip | boolean? | Automatically ZIP the full repository to upload it (default: true) | This will remove the folders `.git/`/`.github/`/`.vscode/` from the repository before zipping. |
| assetName | string | The asset name to re-upload | This is the name of the asset you want to re-upload. |
| assetId | number | The Asset ID, which is a unique ID in the portal | The Asset ID can be found at [portal.cfx.re](https://portal.cfx.re/assets/created-assets). ![image](https://github.com/user-attachments/assets/4176b7e7-cfbb-4e14-a488-04c4301f6082) |
| zipPath | string? | The path to your ZIP file that should be uploaded | This is the file location of your packed ZIP file inside the Workflow Container, usually stored in `/home/...`. |
| uploadPath | string? | The path to your ZIP file that should be uploaded | This is the file location of your packed ZIP file inside the Workflow Container, usually stored in `/home/...`. |
| skipUpload | boolean? | Skip the upload and only log in to the portal | This will skip the asset upload to the portal and only go through the login process. Useful in cron jobs to prevent the cookie from getting invalidated due to inactivity |
| maxRetries | number? | The maximum number of retries. (default: 3) | This is the maximum number of times the login will be retried if it fails. |
| chunkSize | number? | How large one chunk is for upload. Default: 2097152 bytes | |
Expand Down
22 changes: 21 additions & 1 deletion action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,18 @@ inputs:
description: 'The maximum number of retries'
required: false
default: 3
uploadPath:
description:
'The path to the zip file or the folder (if makeZip is set to true) that
should be uploaded. This is the preferred parameter.'
required: false
zipPath:
description: 'The path to the zip file to upload'
description:
'The legacy parameter for specifying the zip file path (deprecated: use
uploadPath instead).'
deprecationMessage:
'zipPath is deprecated and will be removed in a future release. Please use
uploadPath.'
required: false
assetId:
description: 'The asset id to re-upload'
Expand All @@ -35,6 +45,16 @@ inputs:
description: 'The chunk size to split the file into'
required: false
default: 2097152
downloadPath:
description: |
The local path where the asset will be downloaded. Defaults to
"asset-{assetId or download}.zip" if not provided
required: false
download:
description:
'Download the asset from the cfx portal. Defaults to false if not provided'
required: false
default: false

runs:
using: node20
Expand Down
Loading