Time Resource
Implements a resource that reports new versions on a configured interval. The interval can be arbitrarily long.
This resource is built to satisfy "trigger this build at least once every 5 minutes," not "trigger this build on the 10th hour of every Sunday." That level of precision is better left to other tools.
Source Configuration
-
interval
: Optional. The interval on which to report new versions. Valid values:60s
,90m
,1h
. -
location
: Optional. DefaultUTC
. The location in which to interpretstart
,stop
, anddays
.e.g.
location: Africa/Abidjan
-
start
andstop
: Optional. Only create new time versions between this time range. The supported formats for the times are:3:04 PM
,3PM
,3 PM
,15:04
, and1504
.e.g.
start: 8:00 PM stop: 9:00 PM
Deprecation: an offset may be appended, e.g.
+0700
or-0400
, but you should uselocation
instead. -
days
: Optional. Run only on these day(s). Supported days are:Sunday
,Monday
,Tuesday
,Wednesday
,Thursday
,Friday
andSaturday
.e.g.
days: [Monday, Wednesday]
These can be combined to emit a new version on an interval during a particular time period.
Behavior
check
: Produce timestamps satisfying the interval.
Returns current version and new version only if it has been longer than interval
since the
given version, or if there is no version given.
in
: Report the given time.
Fetches the given timestamp, writing the request's metadata to input
in the
destination.
Parameters
None.
out
: Produce the current time.
Returns a version for the current timestamp. This can be used to record the time within a build plan, e.g. after running some long-running task.
Parameters
None.
Examples
Periodic trigger
resources:
- name: 5m
type: time
source: {interval: 5m}
jobs:
- name: something-every-5m
plan:
- get: 5m
trigger: true
- task: something
config: # ...
Trigger once within time range
resources:
- name: after-midnight
type: time
source:
start: 12:00 AM
stop: 1:00 AM
location: Asia/Sakhalin
jobs:
- name: something-after-midnight
plan:
- get: after-midnight
trigger: true
- task: something
config: # ...
Trigger on an interval within time range
resources:
- name: 5m-during-midnight-hour
type: time
source:
interval: 5m
start: 12:00 AM
stop: 1:00 AM
location: America/Bahia_Banderas
jobs:
- name: something-every-5m-during-midnight-hour
plan:
- get: 5m-during-midnight-hour
trigger: true
- task: something
config: # ...
Development
Prerequisites
- golang is required - version 1.9.x is tested; earlier versions may also work.
- docker is required - version 17.06.x is tested; earlier versions may also work.
- go mod is used for dependency management of the golang packages.
Running the tests
The tests have been embedded with the Dockerfile
; ensuring that the testing
environment is consistent across any docker
enabled platform. When the docker
image builds, the test are run inside the docker container, on failure they
will stop the build.
Run the tests with the following commands for both alpine
and ubuntu
images:
docker build -t time-resource -f dockerfiles/alpine/Dockerfile .
docker build -t time-resource -f dockerfiles/ubuntu/Dockerfile .
Contributing
Please make all pull requests to the master
branch and ensure tests pass
locally.