Autogenerate documentation for new releases
まだ誰も着手していません。
評価
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 初心者へのやさしさ
- 38/100
調査の方向性
まず、carvel-release-scripts の .github/workflows/update-install-sh.yml と、carvel/site/hack の release-docs.sh スクリプトを確認してください。新しいバージョンがどのように検出されるか、また workflow がリリースされたツールをどのように特定し、新しいバージョンとメンテナンスリリースをどのように区別するかを追跡してください。リリースによってトリガーされた workflow が、現在の手動プロセスなしで正しいドキュメントバージョンを作成すれば完了です。
索引モデルが issue の本文から書いたものです。
説明
Describe the problem/challenge you have
Right now the process to generate documentation for a new release is done manually following the steps in https://hackmd.io/uVpvITUuR4Cbwzkzb7MEpQ?view#Generate-new-docs-version
This process could be automatically triggered to create a new release when a new version is created.
Describe the solution you'd like
The idea would be similar to what we are doing with the update of the install script in the action https://github.com/vmware-tanzu/carvel-release-scripts/blob/main/.github/workflows/update-install-sh.yml
Anything else you would like to add:
Important things that we should take into account:
- When creating the docs it is important to know if this is a new version on top of the latest release version or a maintenance release since the script https://github.com/vmware-tanzu/carvel/blob/develop/site/hack/release-docs.sh needs that information to correctly produce the documentation
- This new automation needs to know the tool that is being released
Vote on this request
This is an invitation to the community to vote on issues, to help us prioritize our backlog. Use the "smiley face" up to the right of this comment to vote.
👍 "I would like to see this addressed as soon as possible"
👎 "There are other more important things to focus on right now"
We are also happy to receive and review Pull Requests if you want to help work on this issue.
- 主要言語
- Shell
- スター
- 4
- フォーク
- 5
- PR マージ指標
- 30日以内にマージされた PR はありません
環境構築
- Dockerfile・Docker Compose ファイルなし
- プルリクエストのテンプレートなし
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
carvel-dev/release-scripts のほかの issue
-
bug good first issue
難易度 2/5 1〜3時間 初心者へのやさしさ 35/100
carvel-dev/release-scripts#34 · コメント 4 件 ·
-
enhancement
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
carvel-dev/release-scripts#31 · リアクション 1 件 ·
-
enhancement good first issue
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
carvel-dev/release-scripts の issue をすべて見る
似ている issue
-
Webcam overlay freezes during voxtype dictation while screen recording (pause_media pauses the overlay mpv)対応中かも このイシューにリンクされたプルリクエストがオープン中、またはマージ済みです。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
メンテナーはふだん 1 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
TYPO3BestPractices/tea#2409 ·
メンテナーはふだん 1 日以内に返信
-
bug needs-triage
難易度 1/5 1時間未満 初心者へのやさしさ 78/100
mattpocock/skills#1281 ·
メンテナーはふだん 1 日以内に返信
-
pip_install() in notebook_utils.py drops version constraints on Windows because of shell=True対応中かも @prajakta128 が今日担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 80/100
openvinotoolkit/openvino_notebooks#3748 ·
メンテナーはふだん 1 日以内に返信
-
github_actions
難易度 2/5 1〜3時間 初心者へのやさしさ 62/100
hiero-ledger/hiero-consensus-node#27621 ·
メンテナーはふだん 1 日以内に返信