https://github.com/threefoldtech/publish-flist
https://github.com/threefoldtech/publish-flist
Last synced: about 1 month ago
JSON representation
- Host: GitHub
- URL: https://github.com/threefoldtech/publish-flist
- Owner: threefoldtech
- License: apache-2.0
- Created: 2019-10-24T13:47:00.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-01-30T10:28:54.000Z (4 months ago)
- Last Synced: 2025-04-09T17:10:01.894Z (about 1 month ago)
- Size: 21.5 KB
- Stars: 0
- Watchers: 3
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Publish your work on the Zero-OS Hub
You can use this GitHub action to automatically pack
and publish your stuff into the Zero-OS hub.
You can (for now) use 7 differents action within this action:
## Publish
This step can be used to pack your stuff and upload the
resulting flist into the hub (playground).
You can add an optionnal `root` parameter to choose the root directory.
By default `/github/workspace` is used.
The token needs to be a valid Hub JWT token issued from ItsYou.Online.
If you want to use `ThreeFold Connect` token, please use `threefold` and not `token` field.
```yaml
- name: Publishing flist
uses: threefoldtech/publish-flist@master
with:
action: publish
name: demo-from-action.flist
token: ${{ secrets.HUB_TOKEN }}
```
## Promote
This step can be used to promote an flist from a repository
to another. You need to choose your cross-user via `user` input.
The `target` input will be the name of the promoted flist, the `name`
contains the original file and repository `repository/source.flist`
The token needs to be a valid Hub JWT token issued from ItsYou.Online
If you want to use `ThreeFold Connect` token, please use `threefold` and not `token` field.
```yaml
- name: Promoting flist
uses: threefoldtech/publish-flist@master
with:
action: promote
user: tf-official-apps
name: maxux/demo-from-action.flist
target: demo-action-promoted.flist
token: ${{ secrets.HUB_TOKEN }}
```
## Rename
This step can be used to rename an flist to another name, within your repository.
You can use the `user` input to switch to another user before symlinking.
The input `target` will be the new name.
The token needs to be a valid Hub JWT token issued from ItsYou.Online
If you want to use `ThreeFold Connect` token, please use `threefold` and not `token` field.
```yaml
- name: Rename flist
uses: threefoldtech/publish-flist@master
with:
action: rename
user: tf-official-apps
name: my-original.flist
target: my-new-name.flist
token: ${{ secrets.HUB_TOKEN }}
```
## Symlink
This step can be used to symlink an flist to another name, within your repository.
You can use the `user` input to switch to another user before symlinking.
The input `target` will be the link name.
The token needs to be a valid Hub JWT token issued from ItsYou.Online
If you want to use `ThreeFold Connect` token, please use `threefold` and not `token` field.
```yaml
- name: Symlink flist
uses: threefoldtech/publish-flist@master
with:
action: symlink
user: tf-official-apps
name: demo-action-promoted.flist
target: final:symlinked-master.flist
token: ${{ secrets.HUB_TOKEN }}
```
## Cross-Link
This step can be used to symlink across repository (create a symlink in your user, pointing
to a file of another user).
You can use the `user` input to switch to another user before symlinking.
The input `target` will be the destination (link to).
The token needs to be a valid Hub JWT token issued from ItsYou.Online
If you want to use `ThreeFold Connect` token, please use `threefold` and not `token` field.
```yaml
- name: Crosslink flist
uses: threefoldtech/publish-flist@master
with:
action: crosslink
user: tf-official-apps
name: my-crosslink-file.flist
target: maxux/nginx-latest.flist
token: ${{ secrets.HUB_TOKEN }}
```
## Delete
This step can be used to delete one of your flist.
You can use the `user` input to switch to another user before deleting.
The token needs to be a valid Hub JWT token issued from ItsYou.Online
If you want to use `ThreeFold Connect` token, please use `threefold` and not `token` field.
```yaml
- name: Delete flist
uses: threefoldtech/publish-flist@master
with:
action: delete
user: tf-official-apps
name: demo-action-promoted.flist
token: ${{ secrets.HUB_TOKEN }}
```
## Readlink
This step can be used to read the symlink target of an flist, any flist can be resolved.
The resulting name (if the flisti is a symlink) will be set on the output `linkpoint` which
you can reuse later.
```yaml
- name: Readlink of the current build flist
uses: threefoldtech/publish-flist@master
id: readlink
with:
action: readlink
user: tf-official-apps
name: demo-action-symlinked.flist
token: ${{ secrets.HUB_TOKEN }}
- name: Do something with the readlink
run: |
echo "Symlink: ${{ steps.readlink.outputs.linkpoint }}
```
## Merge
This step can be used to merge multiple flist present on the hub, to a single one.
The resulting name (the final flist) is specified by `name` field. The list of
flists you want to merge are specified in `target` and are separated by space.
```yaml
- name: Merge service with ubuntu
uses: threefoldtech/publish-flist@master
with:
action: merge
user: tf-official-apps
name: my-merged-service.flist
target: tf-bootable/ubuntu:18.04.flist maxux/my-service.flist
token: ${{ secrets.HUB_TOKEN }}
```
## Tagging
This step can be used to tag a remote fist into your own tagging repository.
You can use the `user` input to switch to another user before tagging.
The input `name` will be the tag name and link name (eg: v1.0.0/somelink)
The input `target` will be the destination (link to).
The token needs to be a valid Hub JWT token issued from ItsYou.Online
If you want to use `ThreeFold Connect` token, please use `threefold` and not `token` field.
```yaml
- name: Tagging flist
uses: threefoldtech/publish-flist@master
with:
action: tag
user: tf-official-apps
name: v1.0.0/nginx
target: maxux/nginx-latest.flist
token: ${{ secrets.HUB_TOKEN }}
```
## Cross-Tagging
This step can be used to symlink a tag into your repository.
You can use the `user` input to switch to another user before symlinking.
Warning: `name` must not ends with '.flist' !
The input `target` will be the destination (link to).
The token needs to be a valid Hub JWT token issued from ItsYou.Online
If you want to use `ThreeFold Connect` token, please use `threefold` and not `token` field.
```yaml
- name: Crosstag a tag
uses: threefoldtech/publish-flist@master
with:
action: crosstag
user: tf-official-apps
name: my-crosstag-name
target: maxux/v2.0.0
token: ${{ secrets.HUB_TOKEN }}
```