Hacktoberfest 2026: los issues que los mantenedores marcaron para octubre, abiertos y aptos para principiantes. Explorar issues de Hacktoberfest

Write documentation for migrating workflow code

Abierto
#903 0 comentarios 0 reacciones 1 asignado Ver en GitHub

Los mantenedores suelen responder en 1 día

@PiusKariuki ya está trabajando en esto.

Desde el 7/10/2026.

  • #904 de @PiusKariuki — abierto

Evaluación

Este issue todavía no se ha evaluado.

Descripción

P1

Objective

Document how a user can migrate a workflow from one OpenFn project to another by copying its YAML on Lightning.

Scope

  • In scope: Copying workflow YAML between projects via the Lightning UI (export from source, paste into target).

Required Sections

  1. Overview — one paragraph: what YAML migration is, when to use it, what it does not carry over (credentials, run history, webhook URLs).
  2. Prerequisites
    • Access to both source and target projects
    • Matching adaptor versions available on the target instance.
  3. Steps
    • Open the source workflow and export/copy its YAML
    • Open the target project and create a new workflow (or open the workflow editor)
    • Paste the YAML, review the diff, confirm deploy
    • Screenshots for each step
  4. What gets migrated vs. what doesn't
  • Table: jobs, triggers, edges, workflow structure (migrated) vs. credentials, run history, webhook URLs, collaborators (not migrated).
  1. Reconnecting credentials on the target
  • Credentials are referenced by name/ID; show how to recreate or remap them in the target project
  1. Verification checklist
    • Workflow appears in target, adaptor versions resolved, trigger reconfigured, one test run completes
  2. Common pitfalls
    • Adaptor version mismatch
    • Stale credential references

Acceptance Criteria

  • UI steps documented with screenshots
  • Explicit list of what does and does not transfer with the YAML
  • Credential-remapping steps included
  • Verification checklist a user can run through in under 5 minutes
  • Common pitfalls section with at least the 2 cases above
  • Linked from the Workflows index page
Lenguaje dominante
JavaScript
Estrellas
24
Forks
21
Merge medio
1 d 11 h
PR fusionados (30 d)
37

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de OpenFn/docs

Todos los issues de OpenFn/docs

Issues similares

Más issues de JavaScript

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.