2010-10-15 9 views
23

के साथ उपलब्ध जावाडॉक्स बनाना, हालांकि गीथूब जावा ओपन सोर्स प्रोजेक्ट्स के लिए एक अच्छा घर प्रदान करता है, फिर भी कुछ चीजें हैं जो अधिक परिपक्व ओपन सोर्स होस्टिंग स्थानों की तुलना में अभी भी गायब हैं। मैंने अब तक यह पता लगाया है कि सोनाटाइप ओपन सोर्स प्रोजेक्ट्स के लिए मेवेन रिपोजिटरी एक्सेस प्रदान करता है, जो एक मुद्दा हल करता है; और उपयोगकर्ता/dev मेलिंग सूचियों के लिए कई समाधान हैं।गिटहब, सोनाटाइप मेवेन रेपो

लेकिन एक चीज जिसे मैं अब हल करने का प्रयास कर रहा हूं वह ऑनलाइन ब्राउज़िंग के लिए स्वचालित रूप से जेनरेट किए गए जावाडॉक्स प्रकाशित करना है। हालांकि मेवेन के माध्यम से स्रोत जार प्रकाशित करना आईडीई के साथ थोड़ा सा मदद करता है, फिर भी मुझे प्रोजेक्ट डाउनलोड या आयात किए बिना ऑनलाइन जावाडॉक्स ब्राउज़ करने की क्षमता है। क्या किसी को यह हासिल करने के लिए एक अच्छा तरीका पता है, गीथूब में आयोजित परियोजनाओं के लिए? (कुछ गिटब ऑफ़र की आवश्यकता नहीं है, लेकिन आदर्श रूप से रिलीज होने पर स्वचालित होने के लिए कुछ किया जा सकता है)

उत्तर

26

गिटहब स्थिर HTML फ़ाइलों की सेवा करता है जो http://your_username.github.com/your_repo/ पर आपके रेपो की gh-pages शाखा में हैं। सिद्धांत रूप में, मेवेन को निम्नलिखित करने के लिए बनाया जा सकता है:

  1. रिलीज pom.xml रिलीज़ करें।
  2. जावा डॉक्स को .gitignore 'डी निर्देशिका में जेनरेट करें (इसलिए इसे शाखा परिवर्तनों में संरक्षित किया जाएगा)।
  3. gh-pages शाखा चेकआउट करें।
  4. निर्देशिका Javadocs
  5. में प्रतिलिपि की गई कमिट
  6. चेकआउट मूल शाखा के साथ काम कर रहा है कि निर्देशिका में फ़ाइलों के सभी बदलें।
  7. रिलीज के साथ जारी रखें ...

मैं अपनी परियोजनाओं के कुछ के लिए Maven का उपयोग करने में केवल दो दिन कर रहा हूँ तो यह मेरे बूते के बाहर तरीका है। मैं इसे मौजूदा प्लगइन या कस्टम प्लगइन के साथ लागू करने के लिए उत्सुक होगा।

+0

धन्यवाद, कि एक अच्छा विचार है और काफी अच्छी तरह से काम कर सकता है देखते हैं। – StaxMan

+0

एफडब्ल्यूआईडब्ल्यू, इसने बहुत अच्छी तरह से काम किया है, यहां तक ​​कि अधिक स्वचालन के बिना भी। मैं बस 'एमवीएन इंस्टॉल' करता हूं, 'लक्ष्य/एपिडॉक्स' का नाम बदलकर 'जावाडोक/[संस्करण]', 'गिट एड' प्रतिबद्ध करता हूं और यह इसके बारे में है। – StaxMan

+5

एफवाईआई, अब मैं http://khuxtable.github.com/wagon-gitsite/ का उपयोग कर रहा हूं जो पूरी तरह से 'gh-pages' शाखा में साइट परिनियोजन को स्वचालित करता है। –

1

आप/Git चेकआउट कर जोड़ें/प्रतिबद्ध/चेकआउट/धक्का के रूप में जेक व्हार्टन सुझाव दिया करने के लिए एक खोल स्क्रिप्ट का उपयोग करें, और उसके बाद यह जावाडोक उत्पन्न खोल स्क्रिप्ट को चलाने के लिए चींटी या Gradle कॉन्फ़िगर कर सकते हैं। मुझे यकीन नहीं है कि यह मेवेन के साथ काम करेगा। यहां एक example shell script है।

14

अब एक मेवेन प्लगइन है जो एक निर्देशिका को एक विशेष शाखा में गिटिब पर धक्का दे सकता है: http://github.com/github/maven-plugins

0

आप एक भौतिक वेबसाइट बनाने, गिटब पृष्ठों का उपयोग कर सकते हैं, फिर आप अपनी जावाडोक को निर्देशिका में डाल सकते हैं और gh-pages शाखा में प्रवेश कर सकते हैं।

गिट हब पेज, यह सरल और उपयोगी देखें।

http://readwrite.com/2013/11/27/github-pages-explained#awesm=~oII5EQELsqV6S7