2017-12-22 4 views
1

GitHub에 Java Maven 기반 project이 있습니다. 여기에서 documentation on GitHub Pages을 유지 관리합니다.github 페이지에 pom.xml 기반 버전 번호를 포함 하시겠습니까?

두 곳에서 나는 내 maven 프로젝트의 버전 번호를 참조합니다. 현재 수동으로 버전 번호 (한 페이지에 여러 번)로 수동으로 index.mdreadme.md을 업데이트합니다.

버전 번호가 단일 소스를 가질 수있는 방법이 있습니까? 그 중

하나 :

  • 작은 솔루션 : 페이지의 상단에 정의합니다.
  • 중간 솔루션 : 문서에 대해 한 번 정의는 pom.xml 파일에서 읽어

조언

를 감사 :
  • 최선의 해결책 (과제는? 문서화/문서는() readme.md 다른 실행)
  • +0

    Maven으로 전체 사이트를 만드는 방법이 있습니까? https://khmarbaise.github.io/multienv-maven-plugin/ – khmarbaise

    답변

    1

    문제는이 파일들이 두 개의 다른 컨텍스트에서 액세스된다는 것입니다. README.md는 GitHub 자체 또는 repo 복사본에서만 실제로 읽혀집니다. index.md 파일은 index.html 파일로 변환되어 지킬 (Jekyll)이 처리 한 후 웹 페이지에서 볼 수 있습니다.

    작은 해결책 : 페이지 상단에 정의하십시오.

    또 다시 문제는 README.md이 HTML로 처리되지 않기 때문에 전면에 추가하면 마술처럼 콘텐츠에 추가되지 않는다는 것입니다.

    중간 솔루션 : 문서에 대해 한 번 정의 (과제 : 문서에 대한/문서 실행 (다른) readme.md에서)

    는 여전히 README.md의 문제가 아니다 처리되고 있습니다. 그것은 단지 기본 텍스트입니다.

    가장 좋은 방법은 : pom.xml 파일

    당신이 지킬 사이트 내에서 pom.xml 게시물을하지 않는 한 당신은 GitHub의 페이지에서이 작업을 수행 할 수 있습니다에서 그것을 읽었다. 이것은 거의 당신이하고 싶은 것이 아닙니다.

    웹 페이지 콘텐츠를 만드는 Maven 지킬 플러그인을 찾을 수 있습니다. 그렇다면 pom.xml부터 지킬에 변수를 주입 할 수 있습니다. 그런 다음 지킬을 호출하는 GitHub 페이지를 자동으로 포기합니다.

    솔직히 말해서, 당신은 조금 지나치게 생각하고있는 것처럼 들립니다. 내가 너라면, 수동으로 변경하는 간단한 워크 플로를 계속 사용한다. index.md에 frontmatter를 사용하면 한 곳에서 지정할 수 있습니다.

    +0

    을 참조하십시오. 온라인에서 readme.md를 볼 때 HTML로 렌더링됩니다.Jekyll 프로세서를 사용하는지 궁금하다 – stwissel

    +0

    Github 메타 데이터는 "최신 릴리스"개체에 대한 액세스를 허용합니다. – stwissel

    +0

    @stwissel Jekyll이 아닌 HTML로 렌더링됩니다. 적어도 GitHub Pages 마크 다운을 HTML로 바꾸는 지켈은 아닙니다. 'README.md' 파일에 앞부분을 추가하고 내용에서 사용하려고 시도함으로써 이것을 시험 할 수 있습니다. –

    관련 문제