actions/cache-apt-pkgs-action
1
0
Fork 0
mirror of https://github.com/awalsh128/cache-apt-pkgs-action.git synced 2025-09-20 10:07:08 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add link to cache dependencies docs on GirHub.

Browse source
This commit is contained in:
Andrew Walsh 2023-11-26 20:14:38 -08:00
parent 44c33b32f8
commit 36fa5367f6
1 changed files with 26 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

36
README.md
View file

@ -23,24 +23,24 @@ Create a workflow `.yml` file in your repositories `.github/workflows` directory
There are three kinds of version labels you can use. There are three kinds of version labels you can use.
* `@latest` - This will give you the latest release. - `@latest` - This will give you the latest release.
* `@v#` - Major only will give you the latest release for that major version only (e.g. `v1`). - `@v#` - Major only will give you the latest release for that major version only (e.g. `v1`).
* Branch - Branch
* `@master` - Most recent manual and automated tested code. Possibly unstable since it is pre-release. - `@master` - Most recent manual and automated tested code. Possibly unstable since it is pre-release.
* `@staging` - Most recent automated tested code and can sometimes contain experimental features. Is pulled from dev stable code. - `@staging` - Most recent automated tested code and can sometimes contain experimental features. Is pulled from dev stable code.
* `@dev` - Very unstable and contains experimental features. Automated testing may not show breaks since CI is also updated based on code in dev. - `@dev` - Very unstable and contains experimental features. Automated testing may not show breaks since CI is also updated based on code in dev.
### Inputs ### Inputs
* `packages` - Space delimited list of packages to install. - `packages` - Space delimited list of packages to install.
* `version` - Version of cache to load. Each version will have its own cache. Note, all characters except spaces are allowed. - `version` - Version of cache to load. Each version will have its own cache. Note, all characters except spaces are allowed.
* `execute_install_scripts` - Execute Debian package pre and post install script upon restore. See [Caveats / Non-file Dependencies](#non-file-dependencies) for more information. - `execute_install_scripts` - Execute Debian package pre and post install script upon restore. See [Caveats / Non-file Dependencies](#non-file-dependencies) for more information.
### Outputs ### Outputs
* `cache-hit` - A boolean value to indicate a cache was found for the packages requested. - `cache-hit` - A boolean value to indicate a cache was found for the packages requested.
* `package-version-list` - The main requested packages and versions that are installed. Represented as a comma delimited list with equals delimit on the package version (i.e. \<package1>=<version1\>,\<package2>=\<version2>,...). - `package-version-list` - The main requested packages and versions that are installed. Represented as a comma delimited list with equals delimit on the package version (i.e. \<package1>=<version1\>,\<package2>=\<version2>,...).
* `all-package-version-list` - All the pulled in packages and versions, including dependencies, that are installed. Represented as a comma delimited list with equals delimit on the package version (i.e. \<package1>=<version1\>,\<package2>=\<version2>,...). - `all-package-version-list` - All the pulled in packages and versions, including dependencies, that are installed. Represented as a comma delimited list with equals delimit on the package version (i.e. \<package1>=<version1\>,\<package2>=\<version2>,...).
### Cache scopes ### Cache scopes
@ -54,7 +54,6 @@ This was a motivating use case for creating this action.
name: Create Documentation name: Create Documentation
on: push on: push
jobs: jobs:
build_and_deploy_docs: build_and_deploy_docs:
runs-on: ubuntu-latest runs-on: ubuntu-latest
name: Build Doxygen documentation and deploy name: Build Doxygen documentation and deploy
@ -78,8 +77,9 @@ jobs:
``` ```
```yaml ```yaml
...
install_doxygen_deps: ---
install_doxygen_deps:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
@ -95,8 +95,8 @@ jobs:
This action is based on the principle that most packages can be cached as a fileset. There are situations though where this is not enough. This action is based on the principle that most packages can be cached as a fileset. There are situations though where this is not enough.
* Pre and post installation scripts needs to be ran from `/var/lib/dpkg/info/{package name}.[preinst, postinst]`. - Pre and post installation scripts needs to be ran from `/var/lib/dpkg/info/{package name}.[preinst, postinst]`.
* The Debian package database needs to be queried for scripts above (i.e. `dpkg-query`). - The Debian package database needs to be queried for scripts above (i.e. `dpkg-query`).
The `execute_install_scripts` argument can be used to attempt to execute the install scripts but they are no guaranteed to resolve the issue. The `execute_install_scripts` argument can be used to attempt to execute the install scripts but they are no guaranteed to resolve the issue.
@ -121,4 +121,4 @@ For more context and information see [issue #57](https://github.com/awalsh128/ca
### Cache Limits ### Cache Limits
A repository can have up to 5GB of caches. Once the 5GB limit is reached, older caches will be evicted based on when the cache was last accessed. Caches that are not accessed within the last week will also be evicted. A repository can have up to 5GB of caches. Once the 5GB limit is reached, older caches will be evicted based on when the cache was last accessed. Caches that are not accessed within the last week will also be evicted. To get more information on how to access and manage your actions's caches, see [GitHub Actions / Using workflows / Cache dependencies](https://docs.github.com/en/actions/using-workflows/caching-dependencies-to-speed-up-workflows#viewing-cache-entries).