Free Disk Space - Action

Inspiration

Free Disk Space Action are inspired by jlumbroso/free-disk-space

Motivation

At work I came across a huge Docker image that still needed to be analyzed by a local security tool. This consumed the entire Runner and in addition to the repository I found, I needed to remove some packages, which led me to create a modification of the original repository.

I will maintain a Stable version of this project.

Use

name: Free Disk Space (Ubuntu)
on:
  - push

jobs:
  free-disk-space:
    runs-on: ubuntu-latest
    steps:
      - name: Free Disk Space
        uses: endersonmenezes/free-disk-space@v2
        with:
          remove_android: true
          remove_dotnet: true
          remove_haskell: true
          remove_tool_cache: true
          remove_swap: true
          remove_packages: "azure-cli google-cloud-cli microsoft-edge-stable google-chrome-stable firefox postgresql* temurin-* *llvm* mysql* dotnet-sdk-*"
          remove_packages_one_command: true
          remove_folders: "/usr/share/swift /usr/share/miniconda /usr/share/az* /usr/share/glade* /usr/local/lib/node_modules /usr/local/share/chromium /usr/local/share/powershell"
          testing: false

Size Savings

Updated at: 17/02/2024

Option	Estimated Size	Time (For some cases)
remove_android	9036.34 MB	64s~79s
remove_dotnet	1583.80 MB	1s-2s
remove_haskell	5384.87 MB	3s-5s
remove_tool_cache	9009.73 MB	4s-6s
remove_swap	#	#
remove_packages_one_command (Example Provided)	6846.01 MB	101s
package: azure-cli	857.67 MB	27s
package: google-cloud-cli	1002.64 MB	77s
package: microsoft-edge-stable	553.15 MB	4s
package: google-chrome-stable	324.53 MB	4s
package: firefox	240.50 MB	5s
package: postgresql*	61.51 MB	7s
package: temurin-*	989.17 MB	11s
package: llvm	2467.68 MB	14s
package: mysql*	347.55 MB	5s
package: dotnet-sdk-*	3.31 MB	4s
folder: /usr/share/swift	1865.47 MB	#
folder: /usr/share/miniconda	591.45 MB	7s
folder: /usr/share/az_9.3.0	344.33 MB	1s
folder: /usr/local/lib/node_modules	1094.13 MB	22s
folder: /usr/local/share/chromium	499.62 MB	0s
folder: /usr/local/share/powershell	1118.54 MB	0s

The time can vary according to multiple factors this estimed time based on the run: #104

In our action you can see more folders and packages to delete, but is your responsibility to know what you are doing.

Initially I created this project with the intention of doing all this and then being able to use Docker and Python, our tests will prove this.

Local Development

The TESTING variable is used to create an alias for the rm command, so that it does not delete the files in the repository. Are more envs to be added, you will see on main.sh file.

export TESTING=true
bash main.sh

Don't forget to export TESTING=true, it make a alias to rm command

Shellcheck

shellcheck main.sh -o all -e SC2033,SC2032

Contributing

If you have any questions, please open an issue.