This is a Drone extension to support mono repositories with multiple .drone.yml.
The extension checks each changed file and looks for a .drone.yml in the directory of the file or any parent directory. Drone will either use the first .drone.yml that matches or optionally run all of them in a multi-machine build.
There is an official Docker image: https://hub.docker.com/r/bitsbeats/drone-tree-config
Currently supports
- Github
- Gitlab
- Bitbucket #4
PLUGIN_CONCAT: Concats all found configs to a multi-machine build. Defaults tofalse.PLUGIN_FALLBACK: Rebuild all .drone.yml if no changes where made. Defaults tofalse.PLUGIN_ALWAYS_RUN_ALL: Always rebuild all .drone.yml. Useful when repository has a global dependency, like executing tests on all projects in repo before building individual artefacts. Defaults tofalse.PLUGIN_MAXDEPTH: Max depth to search for.drone.yml, only active in fallback and always fallback modes or when pipeline was triggered by cron. Defaults to2(would still find/a/b/.drone.yml).PLUGIN_DEBUG: Set this totrueto enable debug messages.PLUGIN_ADDRESS: Listen address for the plugins webserver. Defaults to:3000.PLUGIN_SECRET: Shared secret with drone. You can generate the token usingopenssl rand -hex 16.PLUGIN_ALLOW_LIST_FILE: (Optional) Path to regex pattern file. Matches the repo slug(s) against a list of regex patterns. Defaults to"", match everything.PLUGIN_CACHE_TTL: (Optional) Cache entry time to live value. When defined and greater than0s, enables in memory caching for request/response pairs.PLUGIN_CONSIDER_FILE: (Optional) Consider file name. Only consider the.drone.ymlfiles listed in this file. When defined, all enabled repos must contain a consider file.PLUGIN_FINALIZE: Adds dependencies to all other pipelines to a user provider pipelined namedfinalize.
Backend specific options
SERVER: Custom SCM server (also used by Gitlab / Bitbucket)- GitHub:
GITHUB_TOKEN: Github personal access token. Only needs repo rights. See here.
- GitLab:
GITLAB_TOKEN: Gitlab personal access token. Only needsread_repositoryrights. See here
- Bitbucket
BITBUCKET_AUTH_SERVER: Custom auth server (uses SERVER if empty)BITBUCKET_CLIENT: Credentials for Bitbucket accessBITBUCKET_SECRET: Credentials for Bitbucket access
If PLUGIN_CONCAT is not set, the first found .drone.yml will be used.
version: '2'
services:
drone-server:
image: drone/drone
ports:
- 8000:80
volumes:
- /var/lib/drone:/data
- /var/run/docker.sock:/var/run/docker.sock
links:
- drone-tree-config
restart: always
environment:
- DRONE_OPEN=true
- DRONE_SERVER_PROTO=https
- DRONE_SERVER_HOST=***
- DRONE_GITHUB=true
- DRONE_GITHUB_SERVER=https://github.com
- DRONE_GITHUB_CLIENT_ID=***
- DRONE_GITHUB_CLIENT_SECRET=***
- DRONE_GIT_ALWAYS_AUTH=true
- DRONE_SECRET=***
- DRONE_RUNNER_CAPACITY=2
- DRONE_YAML_ENDPOINT=http://drone-tree-config:3000
- DRONE_YAML_SECRET=<SECRET>
drone-tree-config:
image: bitsbeats/drone-tree-config
environment:
- PLUGIN_DEBUG=true
- PLUGIN_CONCAT=true
- PLUGIN_FALLBACK=true
- PLUGIN_SECRET=<SECRET>
- GITHUB_TOKEN=<GITHUB_TOKEN>
restart: alwaysEdit the Secrets (***), <SECRET> and <GITHUB_TOKEN> to your needs. <SECRET> is used between Drone and drone-tree-config.
By default, this plugin matches against ALL repo slugs. If you want to enable the plugin for specific repos only, turn on
regex matching by specifying a PLUGIN_ALLOW_LIST_FILE.
- Regex match rules must comply with re2 syntax.
- Each line is a single rule.
- Empty lines are ignored.
- Lines which start with
#are treated as comments (ignored).
Updated docker-compose:
drone-tree-config:
image: bitsbeats/drone-tree-config
environment:
- PLUGIN_DEBUG=true
- PLUGIN_CONCAT=true
- PLUGIN_FALLBACK=true
- PLUGIN_SECRET=<SECRET>
- GITHUB_TOKEN=<GITHUB_TOKEN>
- PLUGIN_ALLOW_LIST_FILE=/drone-tree-config-matchfile
restart: always
volumes:
- /var/lib/drone/drone-tree-config-matchfile:/drone-tree-config-matchfileFile: drone-tree-config-matchfile:
^bitbeats/.*$
^myorg/myrepo$
- Matches against all repos in the
bitbeatsorg - Matches against
myorg/myrepo
If a PLUGIN_CONSIDER_FILE is defined, drone-tree-config will first read the content of the target file and will only consider
the .drone.yml files specified, when matching.
Depending on the size and the complexity of the repository, using a "consider file" can significantly reduce the number of API calls made to the provider (github, bitbucket, other). The reduction in API calls reduces the risk of being rate limited and can result in less processing time for drone-tree-config.
Given the config;
- PLUGIN_CONSIDER_FILE=.drone-considerA local git repo clone;
$ tree -a my-repo-clone/
my-repo-clone/
├── .drone-consier
├── foo
│ └── .drone.yml
├── bar
│ └── .drone.yml
└── baz
Content of the .drone-consider to check in;
$ cat my-repo-clone/.drone-consider
foo/.drone.yml
bar/.drone.ymlThe downside of a "consider file" is that it has to be kept in sync. As a suggestion, to help with this, a step can be
added to each .drone.yml which verifies the "consider file" is in sync with the actual content of the repo. For
example, this can be accomplished by comparing the output of find ./ -name .drone.yml with the content of the "consider file".
If a PLUGIN_CACHE_TTL is defined, drone-tree-config will leverage an in memory cache to match the inbound requests
against ones that exist in the cache. When a match is found, the cached response is returned. Cached entries are
expired and removed when their per-entry TTL is reached.
Example (expire after 30 minutes);
- PLUGIN_CACHE_TTL=30mDepending on the size and the complexity of the repository, using a cache can significantly reduce the number of API calls made to the provider (github, bitbucket, other). The reduction in API calls reduces the risk of being rate limited and can result in less processing time for drone-tree-config.
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent