Merge pull request #669 from kiwix/download_deps_action

Download deps action

actions/dl_deps_archive/README.md

@@ -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
+```

actions/dl_deps_archive/action.yml

@@ -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'