single-commit: true doesn't remove old deployments?

[chriscarrollsmith]

The README suggests that setting single-commit: true will remove all old deployments, but I did not find that to be true after this workflow run:

https://github.com/babafaqirchand/babafaqirchand.github.io/actions/runs/6332179166/job/17198163171

I used:

        uses: JamesIves/github-pages-deploy-action@v4
        with:
          folder: dist
          branch: gh-pages
          single-commit: true

When I go to the gh-pages branch and view, deployments, I still see over 1,000 deployments:

https://github.com/babafaqirchand/babafaqirchand.github.io/deployments

Am I misunderstanding the usage or purpose of this option?

[JamesIves]

This option removes the commit history from the branch you are pushing code to. It cannot remove the deployment history from the GitHub Pages workflow as this isn't managed by the action, instead that's managed by an internal process from GitHub themselves.

If you look at the commit history you'll see you have just a single commit on the gh-pages branch: https://github.com/babafaqirchand/babafaqirchand.github.io/commits/gh-pages/

This option can be toggled to true if you'd prefer to have a single commit on the deployment branch instead of maintaining the full history. Using this option will also cause any existing history to be wiped from the deployment branch.

[chriscarrollsmith]

Gotcha. Thanks for the clarification!

…

On Thu, Sep 28, 2023, 6:30 AM James Ives ***@***.***> wrote: This option removes the *commit history* from the branch you are pushing code to. It cannot remove the deployment history from the GitHub Pages workflow as this isn't managed by the action. If you look at the commit history you'll see you have just a single commit on the gh-pages branch: https://github.com/babafaqirchand/babafaqirchand.github.io/commits/gh-pages/ This option can be toggled to true if you'd prefer to have a single commit on the deployment branch instead of maintaining the full history. Using this option will also cause any existing history to be wiped from the deployment branch. — Reply to this email directly, view it on GitHub <#1446 (comment)>, or unsubscribe <https://github.com/notifications/unsubscribe-auth/ASCYPGM53NJGVBDCJIVGNFLX4VGTBANCNFSM6AAAAAA5KFYM6Q> . You are receiving this because you authored the thread.Message ID: <JamesIves/github-pages-deploy-action/repo-discussions/1446/comments/7132523 @github.com>