Added readme and fixed credential refral

This commit is contained in:
Ampenberger, Chris
2025-10-01 16:49:28 -04:00
parent 7a244ff662
commit 45b69d5b8d
2 changed files with 48 additions and 3 deletions

39
README.md Normal file
View File

@@ -0,0 +1,39 @@
This repository is public and contains shared workflows that are used
in other builds. Each workflow takes a number of parameters and
secrets as inputs. Parameters and secrets are documented in the
respective workflows.
At this point the the following workflows are available:
- ```simple-container.yaml``` - One shot of build of a container through
a given Dockerfile.
- ```go-binary.yaml``` - Builds a golang binary and uploads the binary
as artifact.
- ```container-from-artifact.yaml``` - Builds and uploads a container from
a given artifact and a given Dockerfile.
## Usage
The workflows are used with in a master workflow through a workflow
call, like below. Also see [build.yaml](https://gitea.ampenberger.com/campenbe/synauth/src/branch/main/.gitea/workflows/build.yaml)
for an example
```
....
build-container:
uses: https://gitea.ampenberger.com/campenbe/workflows/.gitea/workflows/container-from-artifact.yaml@2025-10-01-1
with:
artifact_name: my_source_artifact
dockerfile: Dockerfile.small
package-name: cool-project
package-label: v1
version: v1-r1
secrets:
PASSWORD: ${{ secrets.PASSWORD }}
GIT_TOKEN: ${{ secrets.GIT_TOKEN }}
```
## Development
To avoid caching issues always tag a new version and refer to the respective
version with the tag in the consuming workflow.