githubページにpom.xmlベースのバージョン番号を含めますか？

Question

私はdocumentation on GitHub Pagesを維持しているGitHubにJava Mavenベースのprojectを持っています。

私は2つの場所で私のMavenプロジェクトのバージョン番号を参照しています。現在、バージョン番号（1ページに複数回）を使用して手動でindex.mdとreadme.mdを手動で更新しています。

バージョン番号が単一のソースを持つことができる方法はありますか？これらの

ワン：

• 小型ソリューション：ページの上にそれを定義します。
• ミディアムソリューション：ドキュメントのために一度それを定義するには、のpom.xmlからそれを読んで

アドバイスは

を高く評価されています：

ベストソリューション（課題は？ドキュメンテーションのための/ docには、（）readme.mdは異なる動作します）

Answer 1

問題は、これらのファイルが2つの異なるコンテキストでアクセスされることです。README.mdは、GitHub自体、またはレポのコピーで実際に読み取られるだけです。 index.mdファイルは、index.htmlファイルに変換され、Jekyllが処理した後にあなたのWebページで表示されます。

小規模な解決策：ページの上にそれを定義します。

また、問題はREADME.mdがHTMLに処理されないため、フロントマターに追加することによって魔法のようにコンテンツに追加されることはありません。

ミディアムソリューション：ドキュメントのために一度それを定義（？挑戦：readme.mdからドキュメントの/ docには、（異なる動作します））

あなたはまだREADME.md処理されていないという問題があります。基本的なテキストです。

ベストソリューション：あなたのジキルサイト内pom.xmlポストを作成しない限り、あなたは、GitHubのページからこの操作を行うことができないのpom.xml

からそれを読んで。これはほとんど間違いなくあなたがしたいことではありません。

ウェブページのコンテンツを作成するMaven Jekyllプラグインを見つけることができます。もしそうなら、恐らくpom.xmlからジキルに変数を注入することができます。あなたはジキルを呼び出すGitHubのページを自動的にあなたに任せます。

しかし、正直言って、あなたはそれを少し考えすぎているように思えます。私があなただったら、手動で変更するという単純なワークフローを続けていきます。 index.mdにfrontmatterを使用すると、1か所で指定するだけで済みます。