`alias` key is inconsistent in openfn.yaml
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 21
- Forks
- 23
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 17
Description
When checking out a project, should alias get written to openfn.yaml? Probably yes - it makes it more clear which project is checked out to workflows, which is important feedback for tooling and users.
At the moment its use seems to be inconsistent. Sometimes its there, sometimes it's not. See this commit where it was removed.
We should think about the project key some more. Should it just be the aliased name of the checked out project? Do we
actually need any of the other metadata in that file? Looking at it right now I don't think so.
This may relate to https://github.com/OpenFn/kit/issues/1275
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by comparing checkout behavior and the resulting openfn.yaml files, then review commit 89c3277 and related issue 1275. Clarify whether the aliased project name is the only required project key or whether other metadata remains. Done means the chosen metadata is written consistently and the behavior is covered by tests.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- cli, tooling
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 35/100