Skip to content

Commit fa139e1

Browse files
committed
docs: add docs for yamlresume/action
1 parent a38733d commit fa139e1

File tree

14 files changed

+1015
-7
lines changed

14 files changed

+1015
-7
lines changed

content/docs/ecosystem/action.mdx

Lines changed: 148 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,148 @@
1+
---
2+
title: yamlresume/action
3+
---
4+
5+
[yamlresume/action](https://github.com/marketplace/actions/yamlresume) is a GitHub Action to
6+
build professional resumes from YAML files using the YAMLResume CLI. It
7+
seamlessly integrates YAMLResume into your CI/CD pipelines, allowing you to
8+
treat your resume as code and automate PDF, LaTeX, HTML, and Markdown generation
9+
directly on GitHub.
10+
11+
## Features
12+
13+
- **Automated Builds**: Build your resume automatically on every push or pull
14+
request.
15+
- **Multiple Resumes**: Build multiple resumes (e.g., in different languages or
16+
variants) in a single workflow step.
17+
- **Customizable Options**: Skip schema validation or PDF generation if needed.
18+
- **Workflow Integration**: Outputs generated file paths for use in subsequent
19+
steps.
20+
- **Artifact Upload**: Works seamlessly with `actions/upload-artifact` to save
21+
generated files.
22+
23+
## Usage
24+
25+
### Basic Usage
26+
27+
Build a single resume:
28+
29+
```yaml
30+
- uses: yamlresume/action@v0.1.1
31+
with:
32+
resumes: resume.yml
33+
```
34+
35+
### Multiple Resumes
36+
37+
Build multiple resumes using a newline-separated list:
38+
39+
```yaml
40+
- uses: yamlresume/action@v0.1.1
41+
with:
42+
resumes: |
43+
resume-en.yml
44+
resume-zh.yml
45+
resume-fr.yml
46+
```
47+
48+
### Skip PDF Generation
49+
50+
Generate only LaTeX files (useful for custom PDF pipelines):
51+
52+
```yaml
53+
- uses: yamlresume/action@v0.1.1
54+
with:
55+
resumes: resume.yml
56+
no-pdf: true
57+
```
58+
59+
### Skip Validation
60+
61+
Skip schema validation during build:
62+
63+
```yaml
64+
- uses: yamlresume/action@v0.1.1
65+
with:
66+
resumes: resume.yml
67+
no-validate: true
68+
```
69+
70+
### Complete Workflow Example
71+
72+
Here is a complete example of a GitHub Actions workflow that builds multiple
73+
resumes and uploads the generated PDFs as artifacts:
74+
75+
```yaml title=".github/workflows/resume.yml"
76+
name: Build Resume
77+
78+
on:
79+
push:
80+
branches: [main]
81+
pull_request:
82+
branches: [main]
83+
84+
jobs:
85+
build:
86+
runs-on: ubuntu-latest
87+
steps:
88+
- name: Checkout
89+
uses: actions/checkout@v4
90+
91+
- name: Build resumes
92+
id: build
93+
uses: yamlresume/action@v0.1.1
94+
with:
95+
resumes: |
96+
resume-en.yml
97+
resume-zh.yml
98+
verbose: true
99+
100+
- name: Upload PDF artifacts
101+
uses: actions/upload-artifact@v4
102+
with:
103+
name: resumes
104+
path: |
105+
*.pdf
106+
*.tex
107+
```
108+
109+
## Inputs
110+
111+
| Input | Description | Required | Default |
112+
| ------------- | ---------------------------------------------------- | -------- | --------- |
113+
| `resumes` | Newline-separated list of resume YAML files to build | Yes | - |
114+
| `no-validate` | Skip schema validation | No | `false` |
115+
| `no-pdf` | Skip PDF generation (generate only LaTeX) | No | `false` |
116+
| `verbose` | Enable verbose output | No | `false` |
117+
| `version` | YAMLResume Docker image version | No | `v0.11.2` |
118+
119+
## Outputs
120+
121+
The action provides the following outputs, which are newline-separated lists of
122+
generated files:
123+
124+
- `pdf-files`
125+
- `tex-files`
126+
- `html-files`
127+
- `md-files`
128+
129+
### Using Outputs
130+
131+
You can use the outputs in subsequent steps:
132+
133+
```yaml
134+
- uses: yamlresume/action@v0.1.1
135+
id: build
136+
with:
137+
resumes: resume.yml
138+
139+
- run: |
140+
echo "Generated PDFs:"
141+
echo "${{ steps.build.outputs.pdf-files }}"
142+
```
143+
144+
## Requirements
145+
146+
- **Runner**: Linux (Ubuntu recommended) - Docker is required.
147+
- **Docker**: Must be available on the runner (GitHub-hosted Ubuntu runners
148+
include Docker by default).

content/docs/ecosystem/meta.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"pages": ["create-yamlresume", "json2yamlresume", "community"]
2+
"pages": ["action", "create-yamlresume", "json2yamlresume", "community"]
33
}
Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
---
2+
title: yamlresume/action
3+
---
4+
5+
[yamlresume/action](https://github.com/marketplace/actions/yamlresume) es una GitHub Action
6+
para construir currículums profesionales a partir de archivos YAML utilizando la
7+
CLI de YAMLResume. Integra a la perfección YAMLResume en tus pipelines de CI/CD,
8+
permitiéndote tratar tu currículum como código y automatizar la generación de
9+
PDF, LaTeX, HTML y Markdown directamente en GitHub.
10+
11+
## Características
12+
13+
- **Construcciones Automatizadas**: Construye tu currículum automáticamente con
14+
cada push o pull request.
15+
- **Múltiples Currículums**: Construye múltiples currículums (ej. en diferentes
16+
idiomas o variantes) en un solo paso del flujo de trabajo.
17+
- **Opciones Personalizables**: Omite la validación de esquemas o la generación
18+
de PDF si es necesario.
19+
- **Integración con Flujos de Trabajo**: Genera las rutas de los archivos
20+
creados para usarlas en pasos posteriores.
21+
- **Carga de Artefactos**: Funciona sin problemas con `actions/upload-artifact`
22+
para guardar los archivos generados.
23+
24+
## Uso
25+
26+
### Uso Básico
27+
28+
Construir un solo currículum:
29+
30+
```yaml
31+
- uses: yamlresume/action@v0.1.1
32+
with:
33+
resumes: resume.yml
34+
```
35+
36+
### Múltiples Currículums
37+
38+
Construye múltiples currículums utilizando una lista separada por saltos de
39+
línea:
40+
41+
```yaml
42+
- uses: yamlresume/action@v0.1.1
43+
with:
44+
resumes: |
45+
resume-en.yml
46+
resume-zh.yml
47+
resume-fr.yml
48+
```
49+
50+
### Omitir la Generación de PDF
51+
52+
Generar solo archivos LaTeX (útil para pipelines de PDF personalizados):
53+
54+
```yaml
55+
- uses: yamlresume/action@v0.1.1
56+
with:
57+
resumes: resume.yml
58+
no-pdf: true
59+
```
60+
61+
### Omitir la Validación
62+
63+
Omitir la validación de esquemas durante la construcción:
64+
65+
```yaml
66+
- uses: yamlresume/action@v0.1.1
67+
with:
68+
resumes: resume.yml
69+
no-validate: true
70+
```
71+
72+
### Ejemplo Completo de Flujo de Trabajo
73+
74+
Aquí tienes un ejemplo completo de un flujo de trabajo de GitHub Actions que
75+
construye múltiples currículums y sube los PDF generados como artefactos:
76+
77+
```yaml title=".github/workflows/resume.yml"
78+
name: Build Resume
79+
80+
on:
81+
push:
82+
branches: [main]
83+
pull_request:
84+
branches: [main]
85+
86+
jobs:
87+
build:
88+
runs-on: ubuntu-latest
89+
steps:
90+
- name: Checkout
91+
uses: actions/checkout@v4
92+
93+
- name: Build resumes
94+
id: build
95+
uses: yamlresume/action@v0.1.1
96+
with:
97+
resumes: |
98+
resume-en.yml
99+
resume-zh.yml
100+
verbose: true
101+
102+
- name: Upload PDF artifacts
103+
uses: actions/upload-artifact@v4
104+
with:
105+
name: resumes
106+
path: |
107+
*.pdf
108+
*.tex
109+
```
110+
111+
## Entradas
112+
113+
| Entrada | Descripción | Requerido | Por defecto |
114+
| ------------- | ---------------------------------------------------- | --------- | ----------- |
115+
| `resumes` | Lista separada por saltos de línea de archivos YAML | Sí | - |
116+
| `no-validate` | Omitir la validación del esquema | No | `false` |
117+
| `no-pdf` | Omitir la generación de PDF (solo genera LaTeX) | No | `false` |
118+
| `verbose` | Habilitar la salida detallada | No | `false` |
119+
| `version` | Versión de la imagen Docker de YAMLResume | No | `v0.11.2` |
120+
121+
## Salidas
122+
123+
La Action proporciona las siguientes salidas, que son listas separadas por saltos
124+
de línea de los archivos generados:
125+
126+
- `pdf-files`
127+
- `tex-files`
128+
- `html-files`
129+
- `md-files`
130+
131+
### Uso de las Salidas
132+
133+
Puedes utilizar las salidas en pasos posteriores:
134+
135+
```yaml
136+
- uses: yamlresume/action@v0.1.1
137+
id: build
138+
with:
139+
resumes: resume.yml
140+
141+
- run: |
142+
echo "Generated PDFs:"
143+
echo "${{ steps.build.outputs.pdf-files }}"
144+
```
145+
146+
## Requisitos
147+
148+
- **Runner**: Linux (Se recomienda Ubuntu) - Se requiere Docker.
149+
- **Docker**: Debe estar disponible en el runner (los runners Ubuntu alojados en
150+
GitHub incluyen Docker por defecto).
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
{
2-
"pages": ["create-yamlresume", "json2yamlresume", "community"]
2+
"pages": ["action", "create-yamlresume", "json2yamlresume", "community"]
33
}

0 commit comments

Comments
 (0)