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

Download deps action #669

Merged
merged 4 commits into from
Dec 19, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
55 changes: 55 additions & 0 deletions actions/dl_deps_archive/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,55 @@
# Download dependencies archive action

This action download dependencies archive made by kiwix-build.
It is intended to be used in projects using theses dependencies

## Inputs

### `base_url`

The base url where we can download the archive.
This input is provided for greater customization but you probably shouldn't set it.

### `os_name`

The os "name" on which the compilation is done.
By default this use the `OS_NAME` env var, which is set in the docker file.


### `target_platform`

**Required** The targeted platform. Must be provided. Values are kind of :
- native_dyn
- android_arm
- ...

### `project`

The name of the project being compiled.
By default, the name of the repository.


### `branch`

The name of the "branch" to try to download (`/dev_preview/<branch>`).
By default, the current branch on which the action is run.

### `extract_dir`

Where to extract the dependencies archive. By default it is `$HOME`


## Example usage

```yaml
uses: kiwix/kiwix-build/actions/dl_deps_archive@main
with:
target_platform: ${{ matrix.target_platform }}
```

```
uses: kiwix/kiwix-build/actions/dl_deps_archive@main
with:
target_platform: native_mixed
os_name: windows
```
25 changes: 25 additions & 0 deletions actions/dl_deps_archive/action.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
name: 'DL deps archive'
description: 'Download the dependencies archive of the project'
inputs:
base_url: # id of input
description: 'What is the base url to download the archive'
required: false
default: 'https://tmp.kiwix.org/ci'
os_name:
description: "On which os are we running. [Default to env var `OS_NAME`]"
required: false
target_platform:
description: "What platform are we targetting"
required: true
project:
description: "What project are we building"
required: false
branch:
description: "On which branch are we ?"
required: false
extract_dir:
description: "Where to extract our dependencies. [Default to env var `HOME`]"
required: false
runs:
using: 'node20'
main: 'dist/index.js'
Loading