Update README.md
This commit is contained in:
themaster1970sf
GitHub
parent
e4d9adf7c9
commit
d3e2bf4b45
1 changed files with 140 additions and 68 deletions
204
README.md
204
README.md
|
|
@ -1,101 +1,173 @@
|
|||
# Auto Build GitHub Release Automation
|
||||
# 
|
||||
|
||||
## 📦 Описание проекта
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
Скрипт автоматизирует создание релизов в GitHub с ежедневной архивацией содержимого репозитория.
|
||||
## Содержание
|
||||
|
||||
## 🚀 Функциональность
|
||||
* [Описание](#описание)
|
||||
* [Функции](#функции)
|
||||
* [Требования](#требования)
|
||||
* [Установка](#установка)
|
||||
* [Конфигурация](#конфигурация)
|
||||
* [Настройки расписания](#настройки-расписания)
|
||||
* [Запуск](#запуск)
|
||||
* [Важные примечания](#важные-примечания)
|
||||
* [Лицензия](#лицензия)
|
||||
|
||||
- Автоматическое создание архива репозитория
|
||||
- Генерация релиза в GitHub
|
||||
- Загрузка архива как asset релиза
|
||||
- Поддержка Windows и Linux
|
||||
- Настраиваемое расписание
|
||||
## Описание
|
||||
|
||||
## 🛠 Требования
|
||||
Мощный Python-скрипт, автоматизирующий создание релизов на GitHub путем генерации ежедневных архивов содержимого вашего репозитория. Идеально подходит для проектов, требующих регулярных сборок или резервных копий.
|
||||
|
||||
- Python 3.8+
|
||||
- Git
|
||||
- Личный токен GitHub
|
||||
## Функции
|
||||
|
||||
## 📋 Установка
|
||||
* 🔄 **Автоматическое архивирование репозитория** - Создает сжатые архивы вашего репозитория
|
||||
* 🚀 **Генерация релизов на GitHub** - Автоматически создает релизы на GitHub
|
||||
* 📦 **Загрузка ресурсов** - Прикрепляет архивные файлы к каждому релизу
|
||||
* 💻 **Кроссплатформенность** - Работает как на Windows, так и на Linux
|
||||
* ⏱️ **Настраиваемое расписание** - Настройте собственное время выпуска релизов
|
||||
* 🔒 **Безопасная аутентификация** - Использует персональные токены доступа GitHub для безопасного доступа к API
|
||||
|
||||
## Требования
|
||||
|
||||
* Python 3.8 или выше
|
||||
* Установленный и настроенный Git
|
||||
* Персональный токен доступа GitHub с соответствующими разрешениями
|
||||
* Интернет-соединение для доступа к API GitHub
|
||||
|
||||
## Установка
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
|
||||
### Windows
|
||||
</summary>
|
||||
|
||||
1. Клонировать репозиторий:
|
||||
```bash
|
||||
git clone https://github.com/themaster1970sf/AutoBuildRepo.git
|
||||
cd auto-build-script
|
||||
```
|
||||
1. **Клонировать репозиторий**
|
||||
|
||||
2. Установить зависимости:
|
||||
```powershell
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
```bash
|
||||
git clone https://github.com/themaster1970sf/AutoBuildRepo.git
|
||||
cd AutoBuildRepo
|
||||
```
|
||||
|
||||
3. Запуск:
|
||||
```powershell
|
||||
python app.py
|
||||
```
|
||||
2. **Установить зависимости**
|
||||
|
||||
```powershell
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
3. **Запустить скрипт**
|
||||
|
||||
```powershell
|
||||
python app.py
|
||||
```
|
||||
</details>
|
||||
|
||||
<details>
|
||||
<summary>
|
||||
|
||||
### Linux
|
||||
</summary>
|
||||
|
||||
1. Клонировать репозиторий:
|
||||
```bash
|
||||
git clone https://github.com/themaster1970sf/AutoBuildRepo.git
|
||||
cd auto-build-script
|
||||
```
|
||||
1. **Клонировать репозиторий**
|
||||
|
||||
2. Создать виртуальное окружение:
|
||||
```bash
|
||||
python3 -m venv venv
|
||||
source venv/bin/activate
|
||||
```
|
||||
```bash
|
||||
git clone https://github.com/themaster1970sf/AutoBuildRepo.git
|
||||
cd AutoBuildRepo
|
||||
```
|
||||
|
||||
3. Установить зависимости:
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
2. **Создать и активировать виртуальное окружение**
|
||||
|
||||
4. Запуск:
|
||||
```powershell
|
||||
python3 app.py
|
||||
```
|
||||
```bash
|
||||
python3 -m venv venv
|
||||
source venv/bin/activate
|
||||
```
|
||||
|
||||
## 🔧 Настройка
|
||||
3. **Установить зависимости**
|
||||
|
||||
1. Получить Personal Access Token в GitHub
|
||||
2. Отредактировать `daily_release()`:
|
||||
```python
|
||||
repo = {
|
||||
"path": r"/path/to/build",
|
||||
```bash
|
||||
pip install -r requirements.txt
|
||||
```
|
||||
|
||||
4. **Запустить скрипт**
|
||||
|
||||
```bash
|
||||
python3 app.py
|
||||
```
|
||||
</details>
|
||||
|
||||
## Конфигурация
|
||||
|
||||
1. **Получить персональный токен доступа GitHub**
|
||||
|
||||
Создайте токен со следующими разрешениями:
|
||||
- `repo` (Полный контроль над приватными репозиториями)
|
||||
- `workflow` (Обновление рабочих процессов GitHub Action)
|
||||
|
||||
2. **Настроить скрипт**
|
||||
|
||||
Отредактируйте функцию `daily_release()` в файле `app.py`:
|
||||
|
||||
```python
|
||||
repo = {
|
||||
"path": r"/путь/к/сборке",
|
||||
"git_config": {
|
||||
"username": "your_github_username",
|
||||
"repo": "your_repository",
|
||||
"token": "your_github_token"
|
||||
"username": "ваше_имя_пользователя_github",
|
||||
"repo": "ваш_репозиторий",
|
||||
"token": "ваш_токен_github"
|
||||
}
|
||||
}
|
||||
```
|
||||
}
|
||||
```
|
||||
|
||||
## 🕒 Расписание
|
||||
## Настройки расписания
|
||||
|
||||
По умолчанию скрипт запускается ежедневно в 11:23. Чтобы изменить расписание, измените функцию `main()`:
|
||||
|
||||
По умолчанию скрипт запускается ежедневно в 11:23. Изменить время в функции `main()`:
|
||||
```python
|
||||
schedule.every().day.at("HOUR:MINUTE").do(daily_release)
|
||||
schedule.every().day.at("ЧАС:МИНУТА").do(daily_release)
|
||||
```
|
||||
|
||||
## 🐍 Запуск
|
||||
Доступные варианты расписания:
|
||||
- `schedule.every().day.at("ЧЧ:ММ")` - Запуск ежедневно в указанное время
|
||||
- `schedule.every().hour` - Запуск каждый час
|
||||
- `schedule.every().monday` - Запуск каждый понедельник
|
||||
- `schedule.every(10).minutes` - Запуск каждые 10 минут
|
||||
|
||||
## Запуск
|
||||
|
||||
Чтобы запустить автоматический процесс выпуска релизов:
|
||||
|
||||
```bash
|
||||
python app.py
|
||||
```
|
||||
|
||||
## ⚠️ Важно
|
||||
Скрипт продолжит работать в фоновом режиме в соответствии с установленным расписанием.
|
||||
|
||||
- Храните токен в секрете
|
||||
- Проверьте права доступа к репозиторию
|
||||
- Убедитесь в корректности путей
|
||||
## Важные примечания
|
||||
|
||||
## 📄 Лицензия
|
||||
⚠️ **Соображения безопасности**
|
||||
|
||||
[MIT License](https://github.com/themaster1970sf/AutoBuildRepo/blob/main/LICENSE)
|
||||
- Никогда не фиксируйте токен GitHub непосредственно в коде
|
||||
- Рассмотрите возможность использования переменных окружения для хранения конфиденциальной информации
|
||||
- Убедитесь, что ваш репозиторий имеет достаточно места для хранения регулярных архивов
|
||||
- Проверьте, есть ли у вас необходимые разрешения для целевого репозитория
|
||||
|
||||
⚠️ **Соображения производительности**
|
||||
|
||||
- Для больших репозиториев архивирование может занять значительное время
|
||||
- Следите за ограничениями скорости API GitHub
|
||||
- Учитывайте использование пропускной способности сети для больших загрузок
|
||||
|
||||
## Лицензия
|
||||
|
||||
[Лицензия MIT](https://github.com/themaster1970sf/AutoBuildRepo/blob/main/LICENSE)
|
||||
|
||||
---
|
||||
|
||||
<p align="center">
|
||||
Сделано с ❤️ от <a href="https://github.com/themaster1970sf">themaster1970sf</a>
|
||||
</p>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue