Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Project: allow me to write a new project.yaml file without UUIDs

オープン
#1,398 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
30/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
静か
技術スタック
typescript
領域
cli

調査の方向性

関連する issue #1169 を読み、既存の pull、save、export、および可能性のある eject コマンドの経路を追跡することから始めます。.projects に配置せず、UUID、エンドポイントまたはドメインのデータを含めず、状態を .openfn キーの下にグループ化した、単一ファイルのステートレスなプロジェクト表現を共有できれば完了です。

索引モデルが issue の本文から書いたものです。

説明

When I pull a project with new sync, I am left with two different artefacts:

  • A "project.yaml" file (which really needs a better name) which is a direct representation of the project state. It's basically a state.json file, although formatted a bit more cleanly.
  • A "workflows" folder and some config files, which allow me to read and run the workflows of my project locally

We're currently on the verge of saying: the workflows folder is the unit of portability, that's the thing you share with other users.

But a folder is a bit awkward to share. You have to zip it and extract it.

So I'm dithering on the idea of expanded versus unexpected projects.

The projects.yaml file is an unexpanded project - everything in one file. But it's coupled with app state (UUIDs), and I don't want to share that stuff with other users. Plus it's bloaty.

So I need to be able to get a stateless single-file representation of a project. If I export the project from the app, this stateless single file should be what I get. It's exactly the same as the expanded workflows folder, just in one file.

Also important here is that all statey stuff is tucked inside .openfn keys, or something similar. So the state is additive and easy to see.

This is closely related to https://github.com/OpenFn/kit/issues/1169

So I'm repeating myself but this could be an openfn eject command. Or maybe I can pull, save or export with the --stateless command.

Of course the stateless file has no endpoint or domain, and doesn't live in .projects.

主要言語
TypeScript
スター
22
フォーク
22
平均マージ
1日 6時間
マージ済み PR(30日)
26

環境構築

Codespaces で開く

このプロジェクトの開発コンテナを、あなたの GitHub アカウントでブラウザ上に起動します。

  • Dockerfile または Docker Compose ファイルあり
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

OpenFn/kit のほかの issue

OpenFn/kit の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。