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.

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

document full-version, add pointer to docs. #753

Merged
merged 1 commit into from
Oct 17, 2023
Merged

document full-version, add pointer to docs. #753

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 10 additions & 7 deletions README.md
View file
Open in desktop
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