# pack-h5p-action

> Pack a H5P content type and its dependencies to a .h5p file

Latest version **0.0.2** (published 2023-02-20) · ISC license · 0 weekly downloads

## Install

```sh
npm install pack-h5p-action
pnpm add pack-h5p-action
yarn add pack-h5p-action
bun add pack-h5p-action
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned.

## Facts

| | |
|---|---|
| Version | 0.0.2 |
| Published | 2023-02-20 |
| First published | 2023-02-20 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 6 |
| Unpacked size | 1.6 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | GitHub |
| Maintainers | boyum |
| Keywords | actions, h5p |

## Links

- npm: https://www.npmjs.com/package/pack-h5p-action
- Repository: https://github.com/boyum/pack-h5p-action
- Homepage: https://github.com/boyum/pack-h5p-action#readme
- Issues: https://github.com/boyum/pack-h5p-action/issues
- npm.io page: https://npm.io/package/pack-h5p-action

## Dependencies (6)

- [@actions/io](https://npm.io/package/@actions/io.md) ^1.1.2
- [@actions/core](https://npm.io/package/@actions/core.md) ^1.10.0
- [@actions/exec](https://npm.io/package/@actions/exec.md) ^1.1.1
- [@actions/github](https://npm.io/package/@actions/github.md) ^5.1.1
- [@actions/artifact](https://npm.io/package/@actions/artifact.md) ^1.1.1
- [@actions/tool-cache](https://npm.io/package/@actions/tool-cache.md) ^2.0.1

## Recent versions

- 0.0.2 (latest) — 2023-02-20

## README

# H5P Pack Action

This action packs the H5P content type and its dependencies, then archives the `.h5p` file as an artifact.

## Prerequisites

For simple H5P content types with no dependencies, there are none. However, if the content type has dependencies that you'd like to build into the H5P pack, you'll need to create a file that contains the Git URIs of the dependencies, as such:

`build_info/repos`:

```txt
https://github.com/h5p/h5p-dependency-1.git
https://github.com/my-username/h5p-dependency-2.git
```

The default file name is `repos` within the `build_info` directory, however this can be specified with the `h5p-dependency-list-file` option.

## Examples

### Pack and archive the H5P content type

```yml
name: Pack and archive content type

on: [push]

jobs:
  pack-and-archive:
    runs-on: ubuntu-latest
    name: Pack and archive
    steps:
      - uses: actions/checkout@v3
      - uses: boyum/pack-h5p-action@0.0.6
```

### Custom dependency path

```yml
name: Pack and archive content type

on: [push]

jobs:
  pack-and-archive:
    runs-on: ubuntu-latest
    name: Pack and archive
    steps:
      - uses: actions/checkout@v3
      - uses: boyum/pack-h5p-action@0.0.6
        with:
          h5p-dependency-list-file: h5p-dependencies.txt
```

### Release after pack

```yml
name: Pack and release content type

on: [push]

jobs:
  pack-and-release:
    runs-on: ubuntu-latest
    name: Pack and release
    steps:
      - uses: actions/checkout@v3
      - uses: boyum/pack-h5p-action@0.0.6
        id: release-h5p
      - uses: "marvinpinto/action-automatic-releases@latest" # https://github.com/marvinpinto/actions/tree/master/packages/automatic-releases
        if: ${{ github.ref == 'refs/heads/main' }}
        with:
          repo_token: "${{ secrets.GITHUB_TOKEN }}"
          automatic_release_tag: ${{steps.release-h5p.outputs.version}}
          prerelease: false
          files: |
            ${{steps.release-h5p.outputs.filePath}}
```

## Options

| Name | Required | Default value | Description |
|---|---|---|---|
| `h5p-dependency-list-file` | false | `build_info/repos` | The file where dependency Git URIs are found. Must be omitted if the file does not exist. |
| `working-directory` | false | `.` | The directory where `library.json` is found.  |

## Outputs

| Name | Type | Description |
|---|---|---|
| `filePath` | `string` | The path to the archived file |
| `version` | `string` | The content type's version on the form `vx.y.z` |

---
_Source: https://npm.io/package/pack-h5p-action · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._