Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/axel-op/self-contained-dart-github-action
A template to demonstrate how to build a self-contained Dart GitHub Action, that doesn't need a Dart container to run
https://github.com/axel-op/self-contained-dart-github-action
dart dart2native github-action github-actions github-actions-docker github-container-registry github-packages
Last synced: 23 days ago
JSON representation
A template to demonstrate how to build a self-contained Dart GitHub Action, that doesn't need a Dart container to run
- Host: GitHub
- URL: https://github.com/axel-op/self-contained-dart-github-action
- Owner: axel-op
- Created: 2022-02-19T23:15:28.000Z (almost 3 years ago)
- Default Branch: main
- Last Pushed: 2022-02-27T15:13:33.000Z (over 2 years ago)
- Last Synced: 2024-10-13T11:46:29.424Z (about 1 month ago)
- Topics: dart, dart2native, github-action, github-actions, github-actions-docker, github-container-registry, github-packages
- Language: Dockerfile
- Homepage:
- Size: 12.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Self-contained Dart GitHub Action
> [See here](https://gist.github.com/axel-op/deff66ac2f28a01813193d90de36c564) for a comparison of the different ways to build a GitHub Action with Dart.
In 2020, I published the Pub package [`github_actions_toolkit`](https://pub.dev/packages/github_actions_toolkit) to write GitHub Actions with Dart more easily. However, using such actions in a workflow is still cumbersome, as they need [a full Dart container to be pulled](https://github.com/axel-op/containerized-dart-action) before they can be run, which is very time consuming for these scripts that generally run in a few seconds.
This repository is a template to demonstrate how to create a GitHub Action with Dart that is self-contained in a tiny Docker container, that can be pulled and used in a workflow very quickly.
## How it works
The repository leverages the [`dart compile`](https://dart.dev/tools/dart-compile#exe) (ex `dart2native`) command and [GitHub Container Registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-container-registry) to package and publish the Dart action as a small container image.
[A GitHub Action workflow](.github/workflows/push.yml) automatically compiles the Dart application into a native executable using `dart compile`. Then, this executable is wrapped in a Docker container that contains only the libraries required to run it. Finally, the image of this container is published on GitHub Container Registry using the Docker API.
By default, the full image tag is `{OWNER}/{REPOSITORY}:{BRANCH}`, where `BRANCH` is the branch on which the workflow that published the image was executed.
The image is listed at the address [`github.com/{OWNER}/{REPOSITORY}/packages`](https://github.com/axel-op/self-contained-dart-action/packages).
## How to use it in a workflow
The following workflow is inspired by the [`Hello World` example of the GitHub documentation](https://docs.github.com/en/actions/creating-actions/creating-a-docker-container-action#example-using-a-private-action):
```yml
on: [push]
jobs:
test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Hello World action step
# docker://{host}/{image}:{tag}
# See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#example-using-the-github-packages-container-registry
uses: docker://ghcr.io/axel-op/self-contained-dart-action:main
id: hello
with:
who-to-greet: "you"
# Use the output from the `hello` step
- name: Get the output time
run: echo "The time was ${{ steps.hello.outputs.time }}"
```
