Hacktoberfest 2026: những issue maintainer đã đánh dấu cho tháng Mười, đang mở và phù hợp người mới. Xem issue Hacktoberfest

Write documentation for migrating workflow code

Đang mở
  • Có gì không ổn?
#903 0 bình luận 0 reaction 1 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

@PiusKariuki đang làm issue này rồi.

Từ ngày 7/10/2026.

  • #904 của @PiusKariuki — đang mở

Đánh giá

Issue này chưa được đánh giá.

Mô tả

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
Ngôn ngữ chính
JavaScript
Star
24
Fork
21
Merge trung bình
1 ngày 11 giờ
Pull request đã merge (30 ngày)
37

Chuẩn bị môi trường

  • Không có Dockerfile hay tệp Docker Compose
  • Có mẫu pull request
  • Không có hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của OpenFn/docs

Tất cả issue của OpenFn/docs

Issue tương tự

Thêm issue về JavaScript

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.