cleanup-deployments.yml

name: Cleanup Old Deployments

on:
  workflow_run:
    workflows: ["Deploy to GitHub Pages"]
    types: [completed]
  schedule:
    - cron: '15 3 * * *'
  workflow_dispatch:
    inputs:
      keep_count:
        description: Number of most recent deployments to keep
        required: false
        default: '2'
      environment:
        description: Deployment environment to clean
        required: false
        default: github-pages

permissions:
  contents: read
  deployments: write

jobs:
  cleanup:
    # On workflow_run, only proceed when deploy workflow succeeded.
    if: ${{ github.event_name != 'workflow_run' || github.event.workflow_run.conclusion == 'success' }}
    runs-on: ubuntu-latest
    steps:
      - name: Prune old deployment records
        uses: actions/github-script@v7
        with:
          script: |
            const keepInput = core.getInput('keep_count');
            const envInput = core.getInput('environment');

            const keepCount = Number(keepInput || '2');
            const targetEnvironment = envInput || 'github-pages';

            if (!Number.isFinite(keepCount) || keepCount < 1) {
              core.setFailed(`Invalid keep_count: ${keepInput}`);
              return;
            }

            const { owner, repo } = context.repo;
            core.info(`Cleaning deployments for ${owner}/${repo} in environment "${targetEnvironment}"`);
            core.info(`Keeping newest ${keepCount} deployment(s).`);

            const deployments = await github.paginate(github.rest.repos.listDeployments, {
              owner,
              repo,
              environment: targetEnvironment,
              per_page: 100,
            });

            if (!deployments.length) {
              core.info('No deployments found. Nothing to clean.');
              return;
            }

            deployments.sort(
              (a, b) => new Date(b.created_at).getTime() - new Date(a.created_at).getTime(),
            );

            const toDelete = deployments.slice(keepCount);
            core.info(`Found ${deployments.length} deployment(s). Deleting ${toDelete.length}.`);

            for (const deployment of toDelete) {
              core.info(`Processing deployment #${deployment.id} (${deployment.created_at})`);

              // Mark inactive first; this improves deletion success for older records.
              try {
                await github.rest.repos.createDeploymentStatus({
                  owner,
                  repo,
                  deployment_id: deployment.id,
                  state: 'inactive',
                  description: 'Pruned by cleanup workflow',
                  auto_inactive: true,
                });
              } catch (err) {
                core.warning(`Could not mark #${deployment.id} inactive: ${err.message}`);
              }

              try {
                await github.rest.repos.deleteDeployment({
                  owner,
                  repo,
                  deployment_id: deployment.id,
                });
                core.info(`Deleted deployment #${deployment.id}`);
              } catch (err) {
                core.warning(`Could not delete deployment #${deployment.id}: ${err.message}`);
              }
            }

            core.info('Deployment cleanup finished.');