OpenFn / OpenFn/lightning

Remove special characters in job names when exporting from v1 to v2

Open
#1,942 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

migration
Dominant language
Elixir
Stars
296
Forks
86
Avg merge
1d 13h
Merged PRs (30d)
50

Description

The restrictions on the naming patterns for v2 does not allow special characters like [.,/[]()] in the job names. This leads to errors when migrating workflows from v1 to v2.

To fix this, we need to remove all special characters from job names in v1 during export.

This fix is quite tricky as it affects how we generate project.yaml files from the projects. So we need to explore the potential solutions and understand a relative cost of fixing this.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by tracing the v1-to-v2 export path that generates project.yaml files and reviewing the v2 naming restrictions for job names. Determine how special characters such as brackets, periods, slashes, and parentheses are handled; done means exported job names meet v2 restrictions and migrated workflows no longer fail because of invalid names.

Written by the indexing model from the issue text.

Assessment

Tech stack
elixir
Domain
backend
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.