Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Write documentation for migrating workflow code

Aperta
  • Qualcosa non va?
#903 0 commenti 0 reazioni 1 assegnatario Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

@PiusKariuki ci sta già lavorando.

Dal 7/10/2026.

  • #904 di @PiusKariuki — aperta

Valutazione

Questa issue non è ancora stata valutata.

Descrizione

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
Lingua principale
JavaScript
Stelle
24
Fork
21
Merge medio
1g 11h
PR unite (30g)
37

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di OpenFn/docs

Tutte le issue di OpenFn/docs

Issue simili

Altre issue su JavaScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.