mirror of
https://github.com/logos-storage/github-actions.git
synced 2026-01-02 21:23:07 +00:00
95 lines
3.4 KiB
Markdown
95 lines
3.4 KiB
Markdown
# GitHub Actions helpers
|
|
|
|
We are using [GitHub Actions](https://github.com/features/actions) for binaries and Docker builds and sometimes we can reuse existing workflows for similar cases.
|
|
|
|
Repository contains [reusable workflows](https://docs.github.com/en/actions/sharing-automations/reusing-workflows) which can be used across other projects.
|
|
|
|
|
|
## Workflows
|
|
|
|
| Workflow | File | Description |
|
|
| --------------------------------------- | --------------------------------------------------------------- | ------------------------- |
|
|
| [Docker - Reusable](#docker---reusable) | [`docker-reusable.yml`](/.github/workflows/docker-reusable.yml) | Docker amd64/arm64 builds |
|
|
|
|
|
|
### Docker - Reusable
|
|
|
|
This workflow is used for multi-arch builds and it uses native runner, because QEMU is slower.
|
|
|
|
|
|
#### Inputs
|
|
|
|
| Variable | Description | Default |
|
|
| ---------------------- | ---------------------------------- | ------------------- |
|
|
| `docker_file` | Path to Dockerfile | `docker/Dockerfile` |
|
|
| `docker_build_context` | Docker build context | `.` |
|
|
| `dockerhub_repo` | DockerHub repository | `codexstorage/test` |
|
|
| `build_args` | Build arguments | `''` |
|
|
| `tag_latest` | Set latest tag for Docker images | `true` |
|
|
| `tag_sha` | Set Git short commit as Docker tag | `true` |
|
|
| `tag_suffix` | Suffix for Docker images tag | `''` |
|
|
| `checkout-fetch-depth` | actions/checkout fetch-depth | `''` |
|
|
| `checkout-fetch-tags` | actions/checkout fetch-tags | `''` |
|
|
| `amd64_builder` | Builder for amd64 | `ubuntu-22.04` |
|
|
| `arm64_builder` | Builder for arm64 | `ubuntu-22.04-arm` |
|
|
|
|
|
|
#### Secrets
|
|
|
|
Workflow uses `DOCKERHUB_USERNAME` and `DOCKERHUB_TOKEN` secrets to push images to the DockerHub.
|
|
|
|
Also, we can pass secrets required by `build_args`. For that, we should set arg with a value as a variable of the secret name
|
|
```yaml
|
|
VITE_CODEX_API_URL=${VITE_CODEX_API_URL}
|
|
```
|
|
|
|
|
|
#### How to use
|
|
|
|
1. If we are using non GitHub-hosted runners (for ARM builds), we should configure repository to use them.
|
|
|
|
2. Create DockerHub related secrets in the repository
|
|
```shell
|
|
DOCKERHUB_USERNAME
|
|
DOCKERHUB_TOKEN
|
|
```
|
|
|
|
3. Add a workflow to the repository, with the content from examples and adjust for you needs
|
|
```shell
|
|
.github/workflows/docker.yml
|
|
```
|
|
|
|
|
|
#### Examples
|
|
```yaml
|
|
name: Docker
|
|
|
|
|
|
on:
|
|
push:
|
|
branches:
|
|
- master
|
|
tags:
|
|
- 'v*.*.*'
|
|
workflow_dispatch:
|
|
|
|
|
|
jobs:
|
|
build-and-push:
|
|
name: Build and Push
|
|
uses: codex-storage/github-actions/.github/workflows/docker-reusable.yml@master
|
|
with:
|
|
docker_file: docker/Dockerfile
|
|
dockerhub_repo: codexstorage/test
|
|
build_args: |
|
|
VITE_CODEX_API_URL=${VITE_CODEX_API_URL}
|
|
VITE_GEO_IP_URL="Plain text"
|
|
tag_latest: ${{ github.ref_name == github.event.repository.default_branch || startsWith(github.ref, 'refs/tags/') }}
|
|
tag_suffix: 'custom'
|
|
checkout-fetch-depth: 0
|
|
checkout-fetch-tags: true
|
|
amd64_builder: ubuntu-24.04
|
|
arm64_builder: ubuntu-24.04-arm
|
|
secrets: inherit
|
|
```
|