Skip to content

A self-hosted media server and file management system

ci: changelog generation

aminnausin835b1b760887
diff --git a/.github/workflows/ci-main.yml b/.github/workflows/ci-main.yml
index 4c2ed900..6e763071 100644
--- a/.github/workflows/ci-main.yml
+++ b/.github/workflows/ci-main.yml
@@ -9,6 +9,7 @@ on:
branches: [ 'main' ]
paths-ignore:
- "VERSION"
+ - "*.md"
workflow_dispatch:
inputs:
bump:
@@ -31,7 +32,7 @@ jobs:
# ==========================
# Generate Beta Tags
# ==========================
- get-beta-tags:
+ beta-flow:
name: Generate Beta Tags
runs-on: ubuntu-latest
needs: run-tests
@@ -124,105 +125,26 @@ jobs:
# Publish Docker Image
# ==========================
build-docker:
- name: Build Docker Image
- runs-on: ubuntu-latest
- needs: [ get-beta-tags ]
+ needs: [ beta-flow ]
+ uses: ./.github/workflows/release-docker.yml
+ with:
+ docker_tag: 'beta'
+ version_tag: ${{ needs.beta-flow.outputs.tag }}
+ branch: main
permissions:
contents: write
- steps:
- - name: Checkout Repository
- uses: actions/checkout@v4
- with:
- fetch-depth: 0
- submodules: false # Optional — only needed if using submodules
- persist-credentials: false # not needed unless you push
-
- - name: Update .env.docker
- run: |
- sed -i "s/DOCKER_RELEASE=.*/DOCKER_RELEASE=beta/" docker/.env.docker
-
- - name: Login to Docker Hub
- uses: docker/login-action@v3
- with:
- username: ${{ secrets.DOCKER_HUB_USERNAME }}
- password: ${{ secrets.DOCKER_HUB_TOKEN }}
-
- - name: Push to Docker Hub
- uses: docker/build-push-action@v6
- with:
- context: .
- push: true
- tags: |
- aminnausin/mediaserver:beta
- aminnausin/mediaserver:${{ needs.get-beta-tags.outputs.tag }}
-
- # ==========================
- # Check for Docker Changes
- # ==========================
- check-docker-changes:
- name: Check for Docker Related File Changes
- needs: [ run-tests ]
- if: needs.run-tests.result == 'success'
- runs-on: ubuntu-latest
- outputs:
- files_changed: ${{ steps.filter.outputs.changes != '[]' }}
-
- steps:
- - name: Checkout code
- uses: actions/checkout@v4
-
- - name: Check for file changes
- id: filter
- uses: dorny/paths-filter@v2
- with:
- filters: |
- changed:
- - 'docker/**'
- - 'docker-compose.yaml'
- - 'Dockerfile'
- - 'startDocker.*'
- - 'data/**'
- - 'README.md'
-
# ==========================
# Release Docker Setup Pkg
# ==========================
release:
- name: Create GitHub Release
- runs-on: ubuntu-latest
- needs: [ build-docker, check-docker-changes, get-beta-tags ]
- if: needs.check-docker-changes.outputs.files_changed == 'true' || github.event_name == 'workflow_dispatch'
- permissions:
- contents: write
-
- steps:
- - name: Checkout Repository
- uses: actions/checkout@v4
-
- - name: Prepare default data files for release
- run: |
- mkdir -p data
- cp -r storage/app/public/* data
-
- - name: Zip Files Linux
- run: |
- zip -r mediaServerDockerLinux.zip ./docker/etc ./docker/.env.docker ./docker-compose.yaml ./startDocker.sh ./README.md ./data/*
-
- - name: Zip Files Windows
- run: |
- zip -r mediaServerDockerWindows.zip ./docker/etc ./docker/.env.docker ./docker-compose.yaml ./startDocker.bat ./README.md ./data/* ./add-hosts-entry.ps1
-
- - name: Cleanup temp
- run: rm -rf temp
-
- - name: Create Release
- uses: ncipollo/release-action@v1
- with:
- allowUpdates: false
- token: ${{ secrets.GITHUB_TOKEN }}
- tag: ${{ needs.get-beta-tags.outputs.tag }}
- name: Docker Release - ${{ needs.get-beta-tags.outputs.tag }}
- draft: false
- prerelease: true
- artifacts: mediaServerDockerLinux.zip,mediaServerDockerWindows.zip
+ needs: [ build-docker, beta-flow ]
+ uses: ./.github/workflows/release-github.yml
+ with:
+ tag: ${{ needs.beta-flow.outputs.tag }}
+ release_name: 'Beta Release - ${{ needs.beta-flow.outputs.tag }}'
+ is_prerelease: true
+ changelog: ''
+ docker_tag: 'beta'
+ branch: main
+ always_upload_artifacts: false
diff --git a/.github/workflows/ci-prod.yml b/.github/workflows/ci-prod.yml
index a04ec11b..027976e1 100644
--- a/.github/workflows/ci-prod.yml
+++ b/.github/workflows/ci-prod.yml
@@ -29,6 +29,7 @@ jobs:
fail-fast: true
outputs:
tag: ${{ steps.version.outputs.TAG }}
+ previous_tag: ${{ steps.version.outputs.PREVIOUS_TAG }}
steps:
- name: Checkout Repository
@@ -57,8 +58,14 @@ jobs:
# Prod never updates any versions on its own
TAG="$MAJOR.$MINOR.$PATCH"
+ PREVIOUS_TAG=$(git tag --list --sort=-version:refname | grep -E '^[0-9]+\.[0-9]+\.[0-9]+$' | head -n1)
+ PREVIOUS_TAG=${PREVIOUS_TAG:-}
+
echo "::notice::Release Tag: $TAG"
+ echo "::notice::Previous Tag: $PREVIOUS_TAG"
+
echo "TAG=$TAG" >> $GITHUB_OUTPUT
+ echo "PREVIOUS_TAG=$PREVIOUS_TAG" >> $GITHUB_OUTPUT
- name: Create and push Git tag
if: steps.version.outputs.TAG != ''
@@ -77,115 +84,46 @@ jobs:
git push origin ${{ steps.version.outputs.TAG }}
# ==========================
- # Publish Docker Image
+ # Generate Changelog
# ==========================
- build-docker:
- name: Build Docker Image
- runs-on: ubuntu-latest
- needs: [ release-flow ]
+ generate-changelog:
+ name: Generate Changelog
+ needs: release-flow
+ uses: ./.github/workflows/generate-changelog.yml
+ with:
+ previous_tag: ${{ needs.release-flow.outputs.previous_tag }}
+ tag: ${{ needs.release-flow.outputs.tag }}
+ branch: prod
permissions:
contents: write
- steps:
- - name: Checkout Repository
- uses: actions/checkout@v4
- with:
- ref: prod
- fetch-depth: 0
- submodules: false # Optional — only needed if using submodules
- persist-credentials: false # not needed unless you push
-
- - name: Update .env.docker
- run: |
- sed -i "s/DOCKER_RELEASE=.*/DOCKER_RELEASE=latest/" docker/.env.docker
-
- - name: Login to Docker Hub
- uses: docker/login-action@v3
- with:
- username: ${{ secrets.DOCKER_HUB_USERNAME }}
- password: ${{ secrets.DOCKER_HUB_TOKEN }}
-
- - name: Push to Docker Hub
- uses: docker/build-push-action@v6
- with:
- context: .
- push: true
- tags: |
- aminnausin/mediaserver:latest
- aminnausin/mediaserver:${{ needs.release-flow.outputs.tag }}
-
# ==========================
- # Check for Docker Changes
+ # Publish Docker Image
# ==========================
- check-docker-changes:
- name: Check for Docker Related File Changes
- needs: [ run-tests ]
- if: needs.run-tests.result == 'success'
- runs-on: ubuntu-latest
- outputs:
- files_changed: ${{ steps.filter.outputs.changes != '[]' }}
-
- steps:
- - name: Checkout code
- uses: actions/checkout@v4
- with:
- ref: prod
-
- - name: Check for file changes
- id: filter
- uses: dorny/paths-filter@v2
- with:
- filters: |
- changed:
- - 'docker/**'
- - 'docker-compose.yaml'
- - 'Dockerfile'
- - 'startDocker.*'
- - 'data/**'
- - 'README.md'
+ build-docker:
+ needs: [ release-flow ]
+ uses: ./.github/workflows/release-docker.yml
+ with:
+ docker_tag: 'latest'
+ version_tag: ${{ needs.release-flow.outputs.tag }}
+ branch: prod
+ permissions:
+ contents: write
# ==========================
# Release Docker Setup Pkg (Always)
# ==========================
release:
- name: Create GitHub Release
- runs-on: ubuntu-latest
- needs: [ build-docker, check-docker-changes, release-flow ]
- permissions:
- contents: write
-
- steps:
- - name: Checkout Repository
- uses: actions/checkout@v4
- with:
- ref: prod
-
- - name: Prepare default data files for release
- run: |
- mkdir -p data
- cp -r storage/app/public/* data
-
- - name: Zip Files Linux
- run: |
- zip -r mediaServerDockerLinux.zip ./docker/etc ./docker/.env.docker ./docker-compose.yaml ./startDocker.sh ./README.md ./data/*
-
- - name: Zip Files Windows
- run: |
- zip -r mediaServerDockerWindows.zip ./docker/etc ./docker/.env.docker ./docker-compose.yaml ./startDocker.bat ./README.md ./data/* ./add-hosts-entry.ps1
-
- - name: Cleanup temp
- run: rm -rf temp
-
- - name: Create Release
- uses: ncipollo/release-action@v1
- with:
- allowUpdates: false
- token: ${{ secrets.GITHUB_TOKEN }}
- tag: ${{ needs.release-flow.outputs.tag }}
- name: Release - ${{ needs.release-flow.outputs.tag }}
- draft: false
- prerelease: false
- artifacts: mediaServerDockerLinux.zip,mediaServerDockerWindows.zip
+ needs: [ build-docker, release-flow, generate-changelog ]
+ uses: ./.github/workflows/release-github.yml
+ with:
+ tag: ${{ needs.release-flow.outputs.tag }}
+ release_name: 'Release - ${{ needs.release-flow.outputs.tag }}'
+ is_prerelease: false
+ changelog: ${{ needs.generate-changelog.outputs.changelog }}
+ branch: prod
+ docker_tag: 'latest'
+ always_upload_artifacts: true
# ==========================
# Bump Main to Next Version (Only on Prod)
diff --git a/.github/workflows/generate-changelog.yml b/.github/workflows/generate-changelog.yml
new file mode 100644
index 00000000..e4d733fa
--- /dev/null
+++ b/.github/workflows/generate-changelog.yml
@@ -0,0 +1,160 @@
+name: Generate Release Changelogs
+
+# Experimental (First Time AI Generated)
+
+on:
+ workflow_call:
+ inputs:
+ tag:
+ description: 'Release tag'
+ required: true
+ type: string
+ previous_tag:
+ description: 'Previous tag'
+ required: true
+ type: string
+ branch:
+ description: 'Branch to checkout'
+ required: true
+ type: string
+
+jobs:
+ generate-changelog:
+ name: Generate Changelog
+ runs-on: ubuntu-latest
+ permissions:
+ contents: write
+ outputs:
+ changelog: ${{ steps.changelog.outputs.CHANGELOG }}
+
+ steps:
+ - name: Checkout Repository
+ uses: actions/checkout@v4
+ with:
+ ref: ${{ inputs.branch }}
+ fetch-depth: 0
+
+ - name: Generate Changelog from Conventional Commits
+ id: changelog
+ run: |
+ CURRENT_TAG="${{ inputs.tag }}"
+ PREVIOUS_TAG="${{ inputs.previous_tag }}"
+
+ if [ -z "$PREVIOUS_TAG" ]; then
+ echo "No previous tag found, generating full changelog"
+ COMMIT_RANGE=""
+ else
+ COMMIT_RANGE="${PREVIOUS_TAG}..HEAD"
+ fi
+
+ # Generate changelog from conventional commits
+ CHANGELOG_FILE="CHANGELOG_TEMP.md"
+
+ echo "# Release $CURRENT_TAG" > $CHANGELOG_FILE
+ echo "" >> $CHANGELOG_FILE
+ echo "**Release Date:** $(date +%Y-%m-%d)" >> $CHANGELOG_FILE
+ echo "" >> $CHANGELOG_FILE
+
+ # Parse commits by type
+ if [ -z "$COMMIT_RANGE" ]; then
+ COMMITS=$(git log --pretty=format:"%s|||%h|||%an" HEAD)
+ else
+ COMMITS=$(git log --pretty=format:"%s|||%h|||%an" $COMMIT_RANGE)
+ fi
+
+ # Extract features
+ FEATURES=$(echo "$COMMITS" | grep -E "^feat(\(.+\))?:" || true)
+ if [ ! -z "$FEATURES" ]; then
+ echo "## Features" >> $CHANGELOG_FILE
+ echo "" >> $CHANGELOG_FILE
+ echo "$FEATURES" | while IFS='|||' read -r msg hash author; do
+ # Remove the "feat: " or "feat(scope): " prefix
+ clean_msg=$(echo "$msg" | sed -E 's/^feat(\([^)]+\))?:\s*//')
+ echo "- $clean_msg (\`$hash\`)" >> $CHANGELOG_FILE
+ done
+ echo "" >> $CHANGELOG_FILE
+ fi
+
+ # Extract fixes
+ FIXES=$(echo "$COMMITS" | grep -E "^fix(\(.+\))?:" || true)
+ if [ ! -z "$FIXES" ]; then
+ echo "## Bug Fixes" >> $CHANGELOG_FILE
+ echo "" >> $CHANGELOG_FILE
+ echo "$FIXES" | while IFS='|||' read -r msg hash author; do
+ clean_msg=$(echo "$msg" | sed -E 's/^fix(\([^)]+\))?:\s*//')
+ echo "- $clean_msg (\`$hash\`)" >> $CHANGELOG_FILE
+ done
+ echo "" >> $CHANGELOG_FILE
+ fi
+
+ # Extract performance improvements
+ PERF=$(echo "$COMMITS" | grep -E "^perf(\(.+\))?:" || true)
+ if [ ! -z "$PERF" ]; then
+ echo "## Performance Improvements" >> $CHANGELOG_FILE
+ echo "" >> $CHANGELOG_FILE
+ echo "$PERF" | while IFS='|||' read -r msg hash author; do
+ clean_msg=$(echo "$msg" | sed -E 's/^perf(\([^)]+\))?:\s*//')
+ echo "- $clean_msg (\`$hash\`)" >> $CHANGELOG_FILE
+ done
+ echo "" >> $CHANGELOG_FILE
+ fi
+
+ # Extract breaking changes
+ BREAKING=$(echo "$COMMITS" | grep -E "^[^:]+!:|BREAKING CHANGE" || true)
+ if [ ! -z "$BREAKING" ]; then
+ echo "## BREAKING CHANGES" >> $CHANGELOG_FILE
+ echo "" >> $CHANGELOG_FILE
+ echo "$BREAKING" | while IFS='|||' read -r msg hash author; do
+ clean_msg=$(echo "$msg" | sed -E 's/^[^:]+!?:\s*//')
+ echo "- $clean_msg (\`$hash\`)" >> $CHANGELOG_FILE
+ done
+ echo "" >> $CHANGELOG_FILE
+ fi
+
+ # Extract refactors
+ REFACTOR=$(echo "$COMMITS" | grep -E "^refactor(\(.+\))?:" || true)
+ if [ ! -z "$REFACTOR" ]; then
+ echo "## Code Refactoring" >> $CHANGELOG_FILE
+ echo "" >> $CHANGELOG_FILE
+ echo "$REFACTOR" | while IFS='|||' read -r msg hash author; do
+ clean_msg=$(echo "$msg" | sed -E 's/^refactor(\([^)]+\))?:\s*//')
+ echo "- $clean_msg (\`$hash\`)" >> $CHANGELOG_FILE
+ done
+ echo "" >> $CHANGELOG_FILE
+ fi
+
+ # Extract docs
+ DOCS=$(echo "$COMMITS" | grep -E "^docs(\(.+\))?:" || true)
+ if [ ! -z "$DOCS" ]; then
+ echo "## Documentation" >> $CHANGELOG_FILE
+ echo "" >> $CHANGELOG_FILE
+ echo "$DOCS" | while IFS='|||' read -r msg hash author; do
+ clean_msg=$(echo "$msg" | sed -E 's/^docs(\([^)]+\))?:\s*//')
+ echo "- $clean_msg (\`$hash\`)" >> $CHANGELOG_FILE
+ done
+ echo "" >> $CHANGELOG_FILE
+ fi
+
+ # Store changelog for release notes
+ CHANGELOG_CONTENT=$(cat $CHANGELOG_FILE)
+ echo "CHANGELOG<<EOF" >> $GITHUB_OUTPUT
+ echo "$CHANGELOG_CONTENT" >> $GITHUB_OUTPUT
+ echo "EOF" >> $GITHUB_OUTPUT
+
+ # Append to CHANGELOG.md file
+ if [ -f "CHANGELOG.md" ]; then
+ # Prepend new changelog to existing file
+ cat $CHANGELOG_FILE CHANGELOG.md > CHANGELOG_NEW.md
+ mv CHANGELOG_NEW.md CHANGELOG.md
+ else
+ mv $CHANGELOG_FILE CHANGELOG.md
+ fi
+
+ - name: Commit CHANGELOG.md
+ run: |
+ git config user.name "github-actions[bot]"
+ git config user.email "github-actions[bot]@users.noreply.github.com"
+
+ git add CHANGELOG.md
+ git diff --staged --quiet || git commit -m "chore: update CHANGELOG for ${{ inputs.tag }}"
+ git push origin ${{ inputs.branch }}
diff --git a/.github/workflows/release-github.yml b/.github/workflows/release-github.yml
index 4bef08e5..d3a58229 100644
--- a/.github/workflows/release-github.yml
+++ b/.github/workflows/release-github.yml
@@ -105,11 +105,11 @@ jobs:
uses: ncipollo/release-action@v1
with:
allowUpdates: false
+ draft: false
token: ${{ secrets.GITHUB_TOKEN }}
tag: ${{ inputs.tag }}
name: ${{ inputs.release_name }}
body: ${{ inputs.changelog || format('Release {0}', inputs.tag) }}
- draft: false
prerelease: ${{ inputs.is_prerelease }}
artifacts: mediaServerDockerLinux.zip,mediaServerDockerWindows.zip
@@ -118,8 +118,15 @@ jobs:
uses: ncipollo/release-action@v1
with:
allowUpdates: false
+ draft: false
token: ${{ secrets.GITHUB_TOKEN }}
tag: ${{ inputs.tag }}
name: ${{ inputs.release_name }}
body: |
${{ inputs.changelog || format('Release {0}', inputs.tag) }}
+
+ ---
+
+ **Docker Setup Files**
+
+ No Docker-related files were changed in this release. To get the Docker setup packages, download them from a [previous release with Docker changes](https://github.com/${{ github.repository }}/releases).
diff --git a/.github/workflows/ci-docker-release.yml b/.github/workflows_old/ci-docker-release.yml.bak
similarity index 100%
rename from .github/workflows/ci-docker-release.yml
rename to .github/workflows_old/ci-docker-release.yml.bak