🌟Суть:
Автоматическая генерация CHANGELOG.MD из из гитхаб issues / labels / tags metadata.
Так что при аккуратном и ухоженном гитахбе (Issues + PR + Labels + теги в гите) - получается очень красивый отчет прямо из коробки!
Можешь попробовать прямо сейчас на своем гитхаб репо:
#📥 Устаноовка:
gem install github_changelog_generator
# 🚀 Запуск:
github_changelog_generator --user USER --project PROJECT
Вот пример сгенерированого лога:
И сразу видно что пофиксили и кто сделал вклад.
Все красиво:
- с ссылками на таски
- почет тем, кто это сделал
- с датами
- по категориям
Вот пример: CHANGELOG.MD проекта - генерируется автоматически при каждом новом релизе
💡Как появилась идея?
Вдохновило 3 вещи:
- Лень писать ченжлоги
- Боль при виде листа комитов вместо ченжлогов
- Желание знать, что нового появилось в очередной версии (а смотреть в гит западло)
Дальше все по классике:
- у меня болело
- решил сделать для себя
- народу понравилось и это подхватило комьюнити
- ...
- Профит!
⏳Время + 💸Деньги = 🌀⁉️
Пол года делал сам. Потом появились PR с простыми фиксами ляпов (еще бы - я до этого на рубине писал - стыдно было, но зато прокачался!)
А поседение 5 лет помогают другие энтузиасты, самых активных включил в мейнтейнеры проекта.
📚 Стек (💎 vs 🐍)
Хотел красивый удобный скриптовый язык.
По мотивам поста даже создал Батл: 💎Ruby vs 🐍Python?
Python был уже изучен, значит выбор за новым для меня Ruby!
Marketing / CPT / CPM ("А судьи кто?")
В далеком марте 2015-го, после поста на ycombinator в моем проекте появилась 1000+🌟 ( 30🌟 до этого). Это был успех!
Проект с неделю висел в топе Trending github, после чего его занесли в Featured Github projects (по сей день репо числится в коллекции Github: Tools for Open Source)
Успех. (или нет? об этом дальше..)
😵 С какими трудностями пришлось столкнуться?
Да, как и писал @ReDetection про свой проект MTMR:
не хватает мотивации, чтобы внедрять новые офигенные идеи – самому мне уже давно удобно, а долларом никто не поддерживает.
Тем не менее ты чувствуешь ответственность за свое детище, которым уже пользуются сотни тысяч (судя по установкам на rubygems)
🔻Сколько потратили и заработали? Есть идеи как это можно монетизировать?
Сразу: Проект и был некоммерческий.
Подал ради интереса заявку в tidelift - они спонсируют опен-сорс проекты, у которых есть пользовательска база. Меня приняли и теперь присылают 50$ ежемесяцно, которые я думаю, как правильней использовать.
📈Какие планы на будущее?
Проект живет на энтузиазме, понемногу развивается за счет внешних PR's. Прямо как должен Вастрик.Клуб по задумке.
Тем не менее все не так радужно: поддерживать и отвечать на вопросы\запросы людей становится все сложнее и нуднее.
Поэтому я в раздумиях - как лучше поступить с проектом.
Пока сделал issue с криком помощи, но эффекта особо нет. Хотя люди все-таки приходят и помогают.
🙌 Cоветы или помощь Клуба?
Вау! Дочитал до конца? :)
Тгда интересно, что думаете! Поделись своими мыслями!
Также буду рад, если кому поможет тулза в ваших проектах (и напиши об этом мне - я еще раз улыбнусь, что не зря его делал).
Да , GitLab теперь тоже можно - он уже сделан в PR. Этого очень ждут (90 коментов!!).
Но он огромный и у меня пока руки не доходят на ревью. ¯\(ツ)/¯
👣 Какой совет вы бы сами могли дать идущим по вашим стопам?
Как говорят все мейкер-адепты: Если видите проблему - решайте ее.
Возможно, Вы поможете миллионам других людей, получите офигенный (ж)опыт.
Я считаю, что это успех: будто вырастил ребёнка! И теперь он совершеннолетний (живет без моего участия) и развивается практически без моего участия.
Сорян, я обычно скрываю поверхностные описания проектов. Напиши чуть больше подробностей, инсайдов о разработке, проблем на пути. Хорошие примеры есть здесь: https://vas3k.club/project/
О, крутой проект! Надо будет попробовать)
Вот я очень много вижу проектов и библиотек, которые страдают от той же потери интереса. Бывает ещё, что проектом люди пользуются и засылают PRы. Хорошо если на проекте есть кому их принять, а то бывает и некому. В итоге растут форки... И вроде всё бы ничего, но это работает только для маленьких проектов. Для больших и популярных, где форков дофига, Гитхаб отказывается показывать график коммитов среди форков. Короче хрен найдёшь, какой форк популярный, поддерживаемый, и где там починили твою проблему. Когда уже Гитхаб будет заниматься discoverability & maintenance overtake?
Я даже однажды писал утилиту, которая фетчит все форки, чтоб ты локально по ним поискал. https://github.com/ReDetection/forksfetcher
Собственно, вопрос по теме: а чего сложного вести CHANGELOG.md во время разработки? веду у себя в рабочих проектах, очень удобно. Тоже умею группировать по типу, добавлять дату и т.п.