Публікація проекту KiCad на Github

[alk0v]

Процес не дуже інтуітивний і може викликати певні складності. Написав в тому числі щоб самому не забути через певний час

То ж у вас є готовий проект в KiCad.

kicad_project.png

В ньому є папка з герберами, архіви з попередніми версіями в папці backups, які KiCad створює самостійно, файли проекту та кеш.
На моє переконання, в репозиторії є сенс тримати лише файли проекту.
Порядок наступний

Створити новий репозиторій на GitHub

Створюємо новий репозиторій, пишемо йому коротенький дескріпшен. Я не створював одразу файли read.me та gitignore щоб отримати повністю чистий репозиторій та немати проблем з розвязанням конфліктів між файлами в репозиторії та локальними файлами. Тим більше, zip-файли бекапів в gitignore відсутні. Github одразу пропонує певну кількість команд для використання.

github_01.png

github_02.png

Додати локальні файли в репозиторій

Спочатку треба скачати та встановити на комп git client. Далі ще мусить бути фаза авторизації на Github, але я робив її раніше, тому не зберіг інструкцій для цього кроку

Потім переходимо в консолі в папку проекту і пишемо наступні команди:

Код: Виділити все

git init
#ініціалізує новий репозиторій в вашій локальній папці
git add *.kicad_*
#додасть в репозиторій всі потрібні файли проекту по масці.
git status
#покаже які файли будуть трекатись, а які ні. Якщо чогось не вистачає, так само можна додати через git add
git commit -a -m "v.1.0"
#перший комміт, в лапках пишемо до нього коментар, наприклад, версію проекту
git branch -M main
#переменуймо наш основний бранч в main. Ця операція потрібна тому що за замовчуванням основна гілка в гіт-клієнті зветься master, а на github - main
git remote add origin https://github.com/alk0v/tm1637_display.git
#додаємо лінку на ваш репозиторій на гітхабі. На цьому етапі клієнт може спитати за авторизацію, якщо це перший локальний репозиторій
git push -u origin main
#відправляємо всі файли в Github

Після цих операцій репозиторій буде виглядати якось так.

github_03.png

Подальші кроки

Якщо зявляється нова версія проекту після якихось змін, її так само можна закоммітити локально та запушити в гітхаб

Код: Виділити все

git commit -a -m "v.1.1"
git push

Маю переконання, що gerber-файли слід публікувати просто як zip-архів в Releases
То ж на Github створюємо новий реліз і тег з версією для нього:

github_04.png

Якщо все прошло добре і ви готові поділитися своїм репозиторієм, можна зробити його публічним, змінивши налаштування репозиторія

github_05.png