https://github.com/ludeeus/dockerfile-updater

A GitHub action to handle your Dockerfile dependencies.
https://github.com/ludeeus/dockerfile-updater

action alpine apk depencency docker dockerfile management pip pypi python

Last synced: 13 days ago
JSON representation

A GitHub action to handle your Dockerfile dependencies.

• Host: GitHub
• URL: https://github.com/ludeeus/dockerfile-updater
• Owner: ludeeus
• Created: 2020-03-26T22:40:09.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2023-09-05T06:06:39.000Z (about 1 year ago)
• Last Synced: 2024-10-23T19:52:36.273Z (21 days ago)
• Topics: action, alpine, apk, depencency, docker, dockerfile, management, pip, pypi, python
• Language: Python
• Size: 57.6 KB
• Stars: 9
• Watchers: 2
• Forks: 5
• Open Issues: 70
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Dockerfile updater action

_It might not be pretty, but it does a good enough job, this one is for the lazy maintainer._

This will scan your repository for dockerfiles and update pinned versions in them, so you as a maintainer can just sit back and merge PR's.

If an update is found, that will be committed to a new branch and a pull request will be opened.

## Configuration options

Key | Optional | Default | Description

-- | -- | -- | --

`token` | False |  | GitHub token to use in the action `${{ secrets.GITHUB_TOKEN }}`

`pr_title` | True | `Dockerfile updates 🎉` | The title of the PR's this action creates.

`dockerfile_name` | True | `dockerfile` | This action run on all files that contains this value.

`exclude_type` | True |  | A comma separated string of types you don't want to check

`exclude_package` | True | | A comma separated string of packages you don't want to check

`commit_msg` | True | `"Update [package] from [from_version] to [to_version]"` | The string used in commit messages.

`args` | True | | A comma separated string of ARG key/value pairs. i.e. 'ARG1="VALUE1",ARG2="VALUE2'

`disable_pr` | True | False | Disables auto creation of Pull Request.

### Valid types for `exclude_type`

Type | Description

-- | --

`base` | For base image updates

`apk` | For alpine package updates

`pip` | For PyPi pacakge updates

## Recommended action configuration

_It is recommended to run this action with a cron trigger._

```yaml

name: Update Dockerfiles

on:

  schedule:

    - cron:  '40 16 * * *'

jobs:

  deploy:

    name: Update Dockerfiles

    runs-on: ubuntu-latest

    steps:

      - name: 📥 Checkout the repository

        uses: actions/checkout@v2

      - name: 📤 Update Dockerfiles

        uses: ludeeus/dockerfile-updater@main

        with:

          token: ${{ secrets.GITHUB_TOKEN }}

```

_This will run 4:40 PM every day._

## What is updated now

- Your base image (FROM) if you use `alpine` / `debian`

- Packages from PyPi.

- Alpine packages you install with `apk add`

- Special ARG variables, (formats: `ARG S6_OVERLAY="vX.X.X"` / `ARG MYARG`).

## Planed for the future

- Debian packages you install with `apt install`

- More base images.

***

_This project is made with [alpinepkgs](https://pypi.org/project/alpinepkgs), [PyGithub](https://pypi.org/project/PyGithub), [🍺/☕️](https://www.buymeacoffee.com/ludeeus) and [❤️](https://github.com/sponsors/ludeeus)_