Renovate Cron #2899
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| name: Renovate Cron | |
| on: | |
| # This lets you dispatch a renovate job with different cache options if you want to reset or disable the cache manually. | |
| workflow_dispatch: | |
| inputs: | |
| repoCache: | |
| description: 'Reset or disable the cache?' | |
| type: choice | |
| default: enabled | |
| options: | |
| - enabled | |
| - disabled | |
| - reset | |
| schedule: | |
| # Run every 60 minutes: | |
| - cron: '0 * * * *' | |
| # Adding these as env variables makes it easy to re-use them in different steps and in bash. | |
| env: | |
| cache_archive: renovate_cache.tar.gz | |
| # This is the dir renovate provides -- if we set our own directory via cacheDir, we can run into permissions issues. | |
| # It is also possible to cache a higher level of the directory, but it has minimal benefit. While renovate execution | |
| # time gets faster, it also takes longer to upload the cache as it grows bigger. | |
| cache_dir: /tmp/renovate/cache/renovate/repository | |
| # This can be manually changed to bust the cache if neccessary. | |
| cache_key: renovate-cache | |
| jobs: | |
| renovate: | |
| name: Renovate | |
| runs-on: ubuntu-latest | |
| steps: | |
| - uses: actions/checkout@v3 | |
| # This third party action allows you to download the cache artifact from different workflow runs | |
| # Note that actions/cache doesn't work well because the cache key would need to be computed from | |
| # a file within the cache, meaning there would never be any data to restore. With other keys, the | |
| # cache wouldn't necessarily upload when it changes. actions/download-artifact also doesn't work | |
| # because it only handles artifacts uploaded in the same run, and we want to restore from the | |
| # previous successful run. | |
| - uses: dawidd6/action-download-artifact@v2 | |
| if: github.event.inputs.repoCache != 'disabled' | |
| continue-on-error: true | |
| with: | |
| name: ${{ env.cache_key }} | |
| path: cache-download | |
| # Generate an access token for the backstage-goalie[bot] account. | |
| - name: Get token | |
| id: get_token | |
| uses: actions/create-github-app-token@v1 | |
| with: | |
| app-id: ${{ secrets.BACKSTAGE_GOALIE_APPLICATION_ID }} | |
| private-key: ${{ secrets.BACKSTAGE_GOALIE_PRIVATE_KEY }} | |
| owner: ${{ github.repository_owner }} | |
| repositories: ${{ github.event.repository.name }} | |
| # Using tar to compress and extract the archive isn't strictly necessary, but it can improve | |
| # performance significantly when uploading artifacts with lots of files. | |
| - name: Extract renovate cache | |
| run: | | |
| set -x | |
| # Skip if no cache is set, such as the first time it runs. | |
| if [ ! -d cache-download ] ; then | |
| echo "No cache found." | |
| exit 0 | |
| fi | |
| # Make sure the directory exists, and extract it there. Note that it's nested in the download directory. | |
| mkdir -p $cache_dir | |
| tar -xzf cache-download/$cache_archive -C $cache_dir | |
| # Unfortunately, the permissions expected within renovate's docker container | |
| # are different than the ones given after the cache is restored. We have to | |
| # change ownership to solve this. We also need to have correct permissions in | |
| # the entire /tmp/renovate tree, not just the section with the repo cache. | |
| sudo chown -R runneradmin:root /tmp/renovate/ | |
| ls -R $cache_dir | |
| - uses: renovatebot/[email protected] | |
| with: | |
| configurationFile: .github/renovate-action.json | |
| renovate-version: full | |
| token: ${{ steps.get_token.outputs.token }} | |
| env: | |
| # This enables the cache -- if this is set, it's not necessary to add it to renovate.json. | |
| RENOVATE_REPOSITORY_CACHE: ${{ github.event.inputs.repoCache || 'enabled' }} | |
| LOG_LEVEL: DEBUG | |
| # Compression helps performance in the upload step! | |
| - name: Compress renovate cache | |
| run: | | |
| ls $cache_dir | |
| # The -C is important -- otherwise we end up extracting the files with | |
| # their full path, ultimately leading to a nested directory situation. | |
| # To solve *that*, we'd have to extract to root (/), which isn't safe. | |
| tar -czvf $cache_archive -C $cache_dir . | |
| - uses: actions/upload-artifact@v3 | |
| if: github.event.inputs.repoCache != 'disabled' | |
| with: | |
| name: ${{ env.cache_key }} | |
| path: ${{ env.cache_archive }} | |
| # Since this is updated and restored on every run, we don't need to keep it | |
| # for long. Just make sure this value is large enough that multiple renovate | |
| # runs can happen before older cache archives are deleted. | |
| retention-days: 1 |