Хостинг на GitHub

• Создайте репозиторий с теми же name и description, которые указаны в вашем shard.yml.

• Добавьте и зафиксируйте все файлы:

  $ git add -A && git commit -am "shard complete"
  

• Добавьте удалённый репозиторий: (Не забудьте заменить <YOUR-GITHUB-USERNAME> и <YOUR-REPOSITORY-NAME> соответствующими значениями)

  Примечание

  При желании замените public на origin или на любое другое имя удалённого репозитория.

  $ git remote add public https://github.com/<YOUR-GITHUB-NAME>/<YOUR-REPOSITORY-NAME>.git
  

• Отправьте изменения:

  $ git push public master
  

Релизы GitHub

Рекомендуется создавать релизы GitHub.

Добавьте следующий значок сборки в формате Markdown под описанием в файле README, чтобы сообщить пользователям о последнем релизе: (Не забудьте заменить <YOUR-GITHUB-USERNAME> и <YOUR-REPOSITORY-NAME> соответствующими значениями)

[![GitHub release](https://img.shields.io/github/release/<YOUR-GITHUB-USERNAME>/<YOUR-REPOSITORY-NAME>.svg)](https://github.com/<YOUR-GITHUB-USERNAME>/<YOUR-REPOSITORY-NAME>/releases)

Для начала перейдите на страницу релизов вашего репозитория. Она находится по адресу https://github.com/<YOUR-GITHUB-NAME>/<YOUR-REPOSITORY-NAME>/releases

Нажмите «Create a new release».

Согласно файлу README проекта Crystal Shards,

Если библиотеки устанавливаются из репозиториев Git, предполагается, что в репозитории есть теги версий в формате, похожем на semver, с префиксом v. Примеры: v1.2.3, v2.0.0-rc1 или v2017.04.1

В поле с надписью tag version введите v0.1.0. Убедитесь, что это значение совпадает с version в shard.yml. Укажите название v0.1.0 и добавьте краткое описание релиза.

Нажмите «Publish release» — и готово!

Теперь вы увидите, что значок релиза GitHub обновился в файле README.

Следуйте семантическому версионированию и создавайте новый релиз каждый раз, когда отправляете новый код в master.

Непрерывная интеграция

GitHub Actions позволяет автоматически тестировать проект при каждом коммите. Настройте его в соответствии с специальным руководством.

Вы также можете добавить значок состояния сборки под описанием в файле README.md.

Хостинг документации на GitHub Pages

В дополнение к конфигурации GitHub Actions можно добавить шаги для сборки сайта с документацией API и последующей загрузки файлов, например:

    steps:

      - name: Build docs
        run: crystal docs
      - name: Deploy docs
        if: github.event_name == 'push' && github.ref == 'refs/heads/master'
        uses: ...
        with:
          ...

— где последний заполнитель ... обозначает любое стандартное действие GitHub Actions для отправки каталога в ветку gh-pages. Вот несколько вариантов:

• JamesIves/github-pages-deploy-action [Поиск]
• crazy-max/ghaction-github-pages [Поиск]
• peaceiris/actions-gh-pages [Поиск]
• oprypin/push-to-gh-pages [Поиск]

При этом встроенный генератор документации API Crystal создаёт универсальный сайт на основе вашего кода и комментариев к его элементам.

Вместо того чтобы просто публиковать сгенерированную документацию API, подумайте о создании полноценного текстового руководства по проекту, которое даст читателям целостное представление о нём.

Для одного из генераторов статических сайтов — mkdocs-material — есть решение для тесной интеграции документации API с общим сайтом документации: mkdocstrings-crystal. Рассмотрите его как альтернативу crystal docs.