2012-12-06 21 views
7

में जिथब मार्कडाउन फ़ाइलों को कैसे शामिल करें गिथब ने सिफारिश की है कि README.md, LICENCE.md या CONTRIBUTORS.md जैसे मार्कडाउन-स्वरूपित फ़ाइलें प्रोजेक्ट की जड़ में बनाई गई हैं। दूसरी तरफ, वे फ़ाइलें स्वचालित रूप से जेनरेट की गई मैवेन साइट्स के लिए मूल्यवान सामग्री होगी।मैथ्यू साइट

जेनरेट की गई साइट रिपोर्ट में उन फ़ाइलों को शामिल करने का सबसे अच्छा अभ्यास क्या होगा?

एक विचार मैं उन्हें स्रोत/साइट/मार्कडाउन में कॉपी कर रहा था और सफल साइट पीढ़ी के बाद उन्हें फिर से हटा रहा था (एससीएम प्रदूषण से बचने के लिए)।

+1

यदि आप गिट का उपयोग कर रहे हैं तो आप कॉपी किए गए फ़ाइलों को .gitignore में जोड़ सकते हैं ताकि इन फ़ाइलों को स्रोत पेड़ में जोड़ा जा सके। मुझे लगता है कि अन्य वीसीएस में समान तंत्र हैं। –

उत्तर

0

योगदानकर्ताओं को pom में रखा जाना चाहिए। लाइसेंस फ़ाइल आमतौर पर LICENSE.txt को Pom.xml फ़ाइल में भाई के रूप में प्रोजेक्ट का हिस्सा होना चाहिए जैसा अपाचे ने सुझाव दिया था। Apache द्वारा README.txt भी सुझाया गया है। README.md आमतौर पर भंडार के प्रदर्शन के दौरान इसे प्रस्तुत करने के लिए गिटहब के लिए केवल मूल्यवान है।

+1

मैं मेवेन सम्मेलनों से अवगत हूं। मैं केवल डीआरवाई (दोहराना-दोहराएं) सिद्धांत का पालन करते हुए, प्रासंगिक जानकारी की दोहरी प्रतियों को रखने से बचना चाहता हूं। – Hakan

3

मैं दृष्टिकोण आप अपने प्रश्न में उल्लिखित का उपयोग कर एक Git भंडार में फ़ाइल README.md के लिए इस समस्या का समाधान, कि ${baseDir}/src/site/markdown के रूट निर्देशिका से README.md को कॉपी कर रहा है। फ़ाइल की प्रतिलिपि बनाने के लिए मैंने maven-resources-plugin का उपयोग किया। साइट उत्पन्न होने के बाद कॉपी की गई फ़ाइल को हटाने के बजाय (एससीएम प्रदूषण से बचने के लिए), मैंने इसे .gitignore में ब्रूनो suggested के रूप में जोड़ा।

समाधान का एक विस्तृत विवरण निम्नानुसार है।

pom.xml की धारा project.build.plugins में:

<plugin> 
    <groupId>org.apache.maven.plugins</groupId> 
    <artifactId>maven-resources-plugin</artifactId> 
    <executions> 
     <execution> 
      <!-- Copy the readme file to the site source files so that a page is generated from it. --> 
      <id>copy-readme</id> 
      <phase>pre-site</phase> 
      <goals> 
       <goal>copy-resources</goal> 
      </goals> 
      <configuration> 
       <outputDirectory>${basedir}/src/site/markdown</outputDirectory> 
       <resources> 
        <resource> 
         <directory>${basedir}</directory> 
         <includes> 
          <include>README.md</include> 
         </includes> 
        </resource> 
       </resources> 
      </configuration> 
     </execution> 
    </executions> 
</plugin> 

.gitignore में:

# Copied from root to site source files by maven-resources-plugin 
/src/site/markdown/README.md 

आप इसी प्रतिबद्ध here देख सकते हैं।