управление кодом и документацией в той же структуре каталогов git - PullRequest
3 голосов
/ 16 ноября 2011

Я перенес проект из Google Code в Github. Этот проект содержал в одной структуре каталогов код и документацию.

Я бы хотел использовать функциональность "Страницы" Github для размещения html документации. В идеале я хотел бы сделать 1 push, чтобы зафиксировать изменения в коде и документации.

Как мне этого добиться?

1 Ответ

1 голос
/ 16 ноября 2011

Когда дело доходит до страниц GitHub , у вас есть пользовательские страницы и страницы проекта.
Я предполагаю, что вы говорите о последнем, что означает, что вам нужно создать собственную ветку gh-pages, скопировать файлы документации из вашей ветки master в эту новую пустую ветку, как описано на странице документации GitHub.

Оттуда, когда у вас есть новые коммиты в ветвях master и gh-pages, вы можете нажать обе ветки одним нажатием (git push --all)

Проблемы начинаются, когда вы абсолютно хотите видеть обе структуры каталогов одновременно.
Самое простое решение:

  • один клон вашего репо на ветке master.
  • один клон (того же репо) в ветвях gh-pages.
  • символическая ссылка из первого репо во второй репозиторий (которая позволяет вносить изменения в код и документ в одной и той же структуре каталогов. Символьные ссылки даже поддерживаются в Windows начиная с Vista).
  • скрипт псевдонима git для автоматизации последовательности команд 'git push master origin; cd ../secondRepo; git push gh-pages origin'

Вы можете попытаться получить репозиторий в качестве подмодуля вашего основного репо, но ... это кажется более сложным, чем следует: см. " Как добавить репозиторий Git в качестве самого подмодуля? (Или: Как программно генерировать страницы GitHub?)".


Обновление август 2016: Упрощенная публикация страниц GitHub теперь позволяет хранить файлы подкачки в подпапке той же ветки (больше не нужно gh-pages) ):

Now you can select a source in your repository settings and GitHub Pages will look for your content there.

Наконец-то вы можете обновить как код, так и страницы в одной ветке.

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...