Обновлен файл README_GITEA_ACTIONS.md для отражения изменений в workflow и добавления информации о новом тестовом workflow для сборки Docker образов. Создан файл TEST_GITEA_ACTIONS.md для тестирования сборки. Изменен файл docker-build-local.yml для использования переменных окружения из secrets. Эти изменения улучшают документацию и функциональность CI/CD процесса.
This commit is contained in:
parent
cbd5cf5577
commit
ef11a4613a
@ -19,8 +19,7 @@ on:
|
||||
default: 'latest'
|
||||
|
||||
env:
|
||||
# Замените на ваш локальный registry URL
|
||||
REGISTRY: registry.example.com
|
||||
REGISTRY: ${{ secrets.DOCKER_REGISTRY_URL }}
|
||||
IMAGE_NAME: salvagedb/salvagedb-bot
|
||||
|
||||
jobs:
|
||||
@ -35,11 +34,12 @@ jobs:
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Log in to Local Registry
|
||||
if: github.event_name != 'pull_request' && secrets.DOCKER_REGISTRY_USERNAME != '' && secrets.DOCKER_REGISTRY_PASSWORD != ''
|
||||
uses: docker/login-action@v3
|
||||
with:
|
||||
registry: ${{ env.REGISTRY }}
|
||||
username: ${{ secrets.REGISTRY_USERNAME }}
|
||||
password: ${{ secrets.REGISTRY_PASSWORD }}
|
||||
registry: ${{ secrets.DOCKER_REGISTRY_URL }}
|
||||
username: ${{ secrets.DOCKER_REGISTRY_USERNAME }}
|
||||
password: ${{ secrets.DOCKER_REGISTRY_PASSWORD }}
|
||||
|
||||
- name: Generate tags
|
||||
id: tags
|
||||
@ -65,7 +65,7 @@ jobs:
|
||||
context: .
|
||||
file: ./Dockerfile
|
||||
platforms: linux/amd64
|
||||
push: ${{ github.event_name != 'pull_request' }}
|
||||
push: ${{ github.event_name != 'pull_request' && secrets.DOCKER_REGISTRY_USERNAME != '' && secrets.DOCKER_REGISTRY_PASSWORD != '' }}
|
||||
tags: ${{ steps.tags.outputs.tags }}
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
@ -82,9 +82,21 @@ jobs:
|
||||
echo "- **Image:** ${{ env.IMAGE_NAME }}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Tags:** ${{ steps.tags.outputs.tags }}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Commit:** ${{ github.sha }}" >> $GITHUB_STEP_SUMMARY
|
||||
if [[ "${{ github.event_name }}" == "pull_request" ]]; then
|
||||
|
||||
# Проверяем наличие credentials
|
||||
if [[ "${{ secrets.DOCKER_REGISTRY_USERNAME }}" == "" || "${{ secrets.DOCKER_REGISTRY_PASSWORD }}" == "" || "${{ secrets.DOCKER_REGISTRY_URL }}" == "" ]]; then
|
||||
echo "- **🔐 Registry Login:** ❌ Missing credentials" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Action:** Build only (no push to registry)" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "### ⚠️ Configuration Required:" >> $GITHUB_STEP_SUMMARY
|
||||
echo "To push images to registry, configure these secrets:" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- \`DOCKER_REGISTRY_URL\` - registry URL (e.g., registry.gitlab.com)" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- \`DOCKER_REGISTRY_USERNAME\` - registry username" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- \`DOCKER_REGISTRY_PASSWORD\` - registry password/token" >> $GITHUB_STEP_SUMMARY
|
||||
elif [[ "${{ github.event_name }}" == "pull_request" ]]; then
|
||||
echo "- **PR Number:** #${{ github.event.number }}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Action:** Build only (no push)" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Action:** Build only (no push for PR)" >> $GITHUB_STEP_SUMMARY
|
||||
else
|
||||
echo "- **Action:** Build and push" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **🔐 Registry Login:** ✅ Authenticated" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Action:** Build and push to registry" >> $GITHUB_STEP_SUMMARY
|
||||
fi
|
||||
91
.gitea/workflows/docker-build-test.yml
Normal file
91
.gitea/workflows/docker-build-test.yml
Normal file
@ -0,0 +1,91 @@
|
||||
name: Docker Build Test
|
||||
|
||||
on:
|
||||
workflow_dispatch:
|
||||
push:
|
||||
branches:
|
||||
- main
|
||||
- develop
|
||||
paths:
|
||||
- 'Dockerfile'
|
||||
- 'requirements.txt'
|
||||
- '**.py'
|
||||
|
||||
jobs:
|
||||
test-build:
|
||||
runs-on: ubuntu-latest
|
||||
name: Test Docker Build Only
|
||||
|
||||
steps:
|
||||
- name: Checkout repository
|
||||
uses: actions/checkout@v4
|
||||
|
||||
- name: Set up Docker Buildx
|
||||
uses: docker/setup-buildx-action@v3
|
||||
|
||||
- name: Build Docker image (test)
|
||||
uses: docker/build-push-action@v5
|
||||
with:
|
||||
context: .
|
||||
file: ./Dockerfile
|
||||
platforms: linux/amd64
|
||||
push: false
|
||||
tags: |
|
||||
salvagedb-bot:test
|
||||
salvagedb-bot:${{ github.sha }}
|
||||
cache-from: type=gha
|
||||
cache-to: type=gha,mode=max
|
||||
outputs: type=docker,dest=/tmp/image.tar
|
||||
|
||||
- name: Load and test image
|
||||
run: |
|
||||
echo "🔄 Loading Docker image..."
|
||||
docker load -i /tmp/image.tar
|
||||
|
||||
echo "📋 Checking built images:"
|
||||
docker images salvagedb-bot
|
||||
|
||||
echo "🔍 Inspecting image details:"
|
||||
docker inspect salvagedb-bot:test | jq '.[0] | {Created: .Created, Size: .Size, Architecture: .Architecture}'
|
||||
|
||||
echo "✅ Docker image built successfully!"
|
||||
|
||||
- name: Security scan (basic)
|
||||
run: |
|
||||
echo "🛡️ Running basic security checks..."
|
||||
|
||||
# Проверяем базовый образ
|
||||
echo "Base image check:"
|
||||
docker history salvagedb-bot:test --no-trunc --format "table {{.CreatedBy}}" | head -5
|
||||
|
||||
# Проверяем пользователя
|
||||
echo "User check:"
|
||||
docker run --rm salvagedb-bot:test whoami || echo "Cannot determine user"
|
||||
|
||||
# Проверяем размер образа
|
||||
echo "Image size:"
|
||||
docker images salvagedb-bot:test --format "table {{.Repository}}:{{.Tag}}\t{{.Size}}"
|
||||
|
||||
- name: Build Summary
|
||||
run: |
|
||||
IMAGE_SIZE=$(docker images salvagedb-bot:test --format "{{.Size}}")
|
||||
IMAGE_ID=$(docker images salvagedb-bot:test --format "{{.ID}}")
|
||||
|
||||
echo "## 🐳 Docker Build Test Summary" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Event:** ${{ github.event_name }}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Branch:** ${{ github.ref_name }}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Commit:** ${{ github.sha }}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Image Tags:** \`salvagedb-bot:test\`, \`salvagedb-bot:${{ github.sha }}\`" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Image ID:** \`${IMAGE_ID}\`" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- **Image Size:** ${IMAGE_SIZE}" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "### ✅ Tests Performed:" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- ✅ Docker image builds without errors" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- ✅ Image loads and runs correctly" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- ✅ Basic security checks passed" >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "**Note:** This is a test build only. No images were pushed to any registry." >> $GITHUB_STEP_SUMMARY
|
||||
echo "" >> $GITHUB_STEP_SUMMARY
|
||||
echo "### 🚀 Next Steps:" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- Configure registry credentials to enable image publishing" >> $GITHUB_STEP_SUMMARY
|
||||
echo "- Use \`docker-build-local.yml\` workflow for registry deployment" >> $GITHUB_STEP_SUMMARY
|
||||
@ -2,11 +2,12 @@
|
||||
|
||||
## Обзор
|
||||
|
||||
В проекте настроены три workflow для автоматической сборки Docker образов:
|
||||
В проекте настроены четыре workflow для автоматической сборки Docker образов:
|
||||
|
||||
1. `docker-build.yml` - для публикации в Docker Hub
|
||||
2. `docker-build-local.yml` - для публикации в локальный registry
|
||||
3. `pull-request-check.yml` - для проверки сборки в pull request (только тестирование)
|
||||
3. `docker-build-test.yml` - только тестирование сборки (без registry)
|
||||
4. `pull-request-check.yml` - для проверки сборки в pull request
|
||||
|
||||
## Настройка
|
||||
|
||||
@ -32,8 +33,9 @@ DEFAULT_ACTIONS_URL = https://gitea.com
|
||||
|
||||
#### Для локального registry (docker-build-local.yml):
|
||||
|
||||
- `REGISTRY_USERNAME` - username для локального registry
|
||||
- `REGISTRY_PASSWORD` - пароль для локального registry
|
||||
- `DOCKER_REGISTRY_URL` - адрес Docker registry (например: `registry.gitlab.com`, `your-harbor.com`)
|
||||
- `DOCKER_REGISTRY_USERNAME` - username для локального registry
|
||||
- `DOCKER_REGISTRY_PASSWORD` - пароль или токен для локального registry
|
||||
|
||||
### 3. Конфигурация registry
|
||||
|
||||
@ -46,13 +48,14 @@ docker.io/YOUR_USERNAME/salvagedb-bot:v1.0.0
|
||||
```
|
||||
|
||||
#### Локальный registry
|
||||
Отредактируйте файл `.gitea/workflows/docker-build-local.yml`:
|
||||
|
||||
```yaml
|
||||
env:
|
||||
REGISTRY: your-registry.example.com # Замените на ваш URL
|
||||
IMAGE_NAME: salvagedb/salvagedb-bot # Замените на желаемое имя
|
||||
Workflow автоматически использует URL из secrets. Образы будут доступны как:
|
||||
```
|
||||
${DOCKER_REGISTRY_URL}/salvagedb/salvagedb-bot:latest
|
||||
${DOCKER_REGISTRY_URL}/salvagedb/salvagedb-bot:main
|
||||
${DOCKER_REGISTRY_URL}/salvagedb/salvagedb-bot:v1.0.0
|
||||
```
|
||||
|
||||
При необходимости измените `IMAGE_NAME` в файле `.gitea/workflows/docker-build-local.yml`
|
||||
|
||||
## Триггеры сборки
|
||||
|
||||
@ -90,6 +93,12 @@ env:
|
||||
- `pr-123` - для pull requests (не публикуется)
|
||||
- Произвольные теги при ручном запуске
|
||||
|
||||
### Docker Build Test workflow:
|
||||
- Только сборка и тестирование (без registry)
|
||||
- Запускается при ручном запуске или изменении Dockerfile/Python файлов
|
||||
- Идеален для проверки сборки без настройки credentials
|
||||
- Включает базовые проверки безопасности
|
||||
|
||||
### Pull Request Check workflow:
|
||||
- Только сборка и тестирование (не публикация)
|
||||
- Валидация Dockerfile
|
||||
@ -119,17 +128,29 @@ Docker Hub workflow собирает образы для:
|
||||
|
||||
### Troubleshooting
|
||||
|
||||
#### Ошибка "Username and password required":
|
||||
```
|
||||
::error::Username and password required
|
||||
```
|
||||
**Решение:**
|
||||
1. Убедитесь, что настроены все необходимые secrets в Gitea
|
||||
2. Secrets должны называться: `DOCKER_REGISTRY_URL`, `DOCKER_REGISTRY_USERNAME`, `DOCKER_REGISTRY_PASSWORD`
|
||||
3. Или используйте `docker-build-test.yml` для тестирования без registry
|
||||
|
||||
#### Ошибки аутентификации:
|
||||
- Проверьте правильность secrets
|
||||
- Убедитесь, что токены имеют права на push
|
||||
- Для Docker Hub используйте Access Token, не пароль
|
||||
|
||||
#### Ошибки сборки:
|
||||
- Проверьте валидность Dockerfile
|
||||
- Убедитесь, что все зависимости доступны
|
||||
- Используйте `docker-build-test.yml` для локального тестирования
|
||||
|
||||
#### Проблемы с registry:
|
||||
- Проверьте доступность registry
|
||||
- Убедитесь в правильности URL
|
||||
- Убедитесь, что registry поддерживает Docker API v2
|
||||
|
||||
## Использование собранных образов
|
||||
|
||||
|
||||
1
TEST_GITEA_ACTIONS.md
Normal file
1
TEST_GITEA_ACTIONS.md
Normal file
@ -0,0 +1 @@
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user