Skip to content

Commit

Permalink
document full-version, add pointer to docs.
Browse files Browse the repository at this point in the history
Signed-off-by: Ville Aikas <[email protected]>
  • Loading branch information
vaikas committed Oct 12, 2023
1 parent 4e177bc commit e9dbc6d
Showing 1 changed file with 10 additions and 7 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,13 +146,14 @@ pipeline:

Melange provides the following default substitutions which can be referenced in the build file pipeline:

| **Substitution** | **Description** |
|--------------------------|---------------------------------------------------|
| `${{package.name}}` | Package name |
| `${{package.version}}` | Package version |
| `${{package.epoch}}` | Package epoch |
| `${{targets.destdir}}` | Directory where targets will be stored |
| `${{targets.subpkgdir}}` | Directory where subpackage targets will be stored |
| **Substitution** | **Description** |
|-----------------------------|---------------------------------------------------|
| `${{package.name}}` | Package name |
| `${{package.version}}` | Package version |
| `${{package.epoch}}` | Package epoch |
| `${{package.full-version}}` | `${{package.version}}-r${{package-epoch}}` |
| `${{targets.destdir}}` | Directory where targets will be stored |
| `${{targets.subpkgdir}}` | Directory where subpackage targets will be stored |

An example build file pipeline with substitutions:

Expand All @@ -162,6 +163,8 @@ pipeline:
runs: mkdir ${{targets.destdir}}/var/lib/${{package.name}}/tmp
```
[More detailed documentation](./docs/)
## Usage with apko
To use a melange built apk in apko, either upload it to a package repository or use a "local" repository. Using a local repository allows a melange build and apko build to run in the same directory (or GitHub repo) without using external storage.
Expand Down

0 comments on commit e9dbc6d

Please sign in to comment.