Content

UpToDate Action

Usage

name: uptodate
on:
 schedule:
 - cron: "0 0 * * *"
jobs:
 uptodate:
 runs-on: ubuntu-latest
 steps:
 # You have to check out your repo first.
 - uses: actions/checkout@v2
 - uses: fischerscode/uptodate@v0.7
 with:
 # The location of the config file.
 # Defaults to '.uptodate.yaml'
 config: ''
 # The token used for creating issues.
 # Defaults to ${{ github.token }}
 token: ''
 # The target repository for new issues.
 # Defaults to ${{ github.repository }}
 repository: ''

UpToDate as a command line tool

Usage

A tool that helps you to keep your repository up to date.
Usage: uptodate <command> [arguments]
Global options:
-h, --help Print this usage information.
-f, --file (mandatory) The config file.
-v, --[no-]verbose Detailed output.
Available commands:
 check Check the dependencies in the config file for updates.
 github Check for updates and create issues in your GitHub repository.
 version Print uptodate version.
Run "uptodate help <command>" for more information about a command.

Configuration

Config file

dependencies: # The unsorted list containing the dependencies.
 - name: testdependency # The name of the dependency
 type: typ # The type of the dependency
 currentVersion: 1.2.3 # The current version of the dependency
 issueLabels: # The labels added to the issue
 - dependencies
 - test
defaultIssueTitle: "Update $name to $latestVersion" # The default issue title
defaultIssueBody: "Update $name to $latestVersion" # The default issue body

Dependency types

Web dependency

dependencies:
 - name: testdependency # The name of the dependency. (required)
 type: web # The type of the dependency. (required)
 currentVersion: 1.2.3 # The current version of the dependency. (required)
 url: 'http://example.com' # The url that gets called. (required)

Json web dependency

dependencies:
 - name: testdependency # The name of the dependency. (required)
 type: webjson # The type of the dependency. (required)
 currentVersion: 1.2.3 # The current version of the dependency. (required)
 url: 'http://example.com' # The url that gets called. (required)
 path: args.versions.0.version # The path to the latest version. (defaults to '')
 prefix: v # The prefix of the semantic versions. 
 # (v1.2.3 instead of 1.2.3)
 # Defaults to ''

Yaml web dependency

dependencies:
 - name: testdependency # The name of the dependency. (required)
 type: webyaml # The type of the dependency. (required)
 currentVersion: 1.2.3 # The current version of the dependency. (required)
 url: 'http://example.com' # The url that gets called. (required)
 path: args.versions.0.version # The path to the latest version. (defaults to '')
 prefix: v # The prefix of the semantic versions. 
 # (v1.2.3 instead of 1.2.3)
 # Defaults to ''

GitHub dependency

dependencies:
 - name: gitdependency # The name of the dependency. (required)
 type: github # The type of the dependency. (required)
 currentVersion: v1.2.3 # The current version of the dependency. (required)
 repo: 'fischerscode/uptodate' # The repository. (required)
 isTag: true # Wether the version is determined by the latest
 # tag rather then release (defaults to false)
 path: tag_name # The path to the latest version. (defaults to tag_name)
 prefix: v # The prefix of the semantic versions. 
 # Is set, releases/tags not matching the prefix are ignored.
 # (v1.2.3 instead of 1.2.3)
 # Defaults to ''

Helm dependency

dependencies:
 - name: helmdependency # The name of the dependency. (required)
 type: helm # The type of the dependency. (required)
 currentVersion: v1.2.3 # The current version of the dependency. (required)
 repo: 'https://helm.traefik.io/traefik' # The repository. (required)
 chart: traefik # The chart. (required)
 prefix: v # The prefix of the semantic versions. 
 # (v1.2.3 instead of 1.2.3)
 # Defaults to ''
 path: 'entries.traefik.0.version' # The path to the latest version. (defaults to 'entries.$chart.0.version')