.flycode.yaml
All you need to know about the FlyCode configuration file
When installing the FlyCode GitHub Application, FlyCode scans the GitHub repositories you've granted access to and learns your projects' structures.
FlyCode generates a .flycode.yaml configuration file in the repository root, and identifies your:
  • Apps located in different directories.
  • Environments - Branches & Tags that represent your environments and workflows.
  • Resource Files that contain all your texts, whether in JSON files or hardcoded.
Here is an example of how a .flycode.yaml looks like, with explanations regarding each section:
1
version: 0.1
2
​
3
# FlyCode supports mono-repos in which you manage multiple apps
4
apps:
5
​
6
# We still need you to give human readable names :)
7
- name: App Dashboard
8
path: dashboard/frontend/
9
​
10
# We guess your resource file location and structure
11
text-resources:
12
- path: src/lang/*.json
13
format: formatjs
14
​
15
- name: App Admin
16
path: admin/frontend/
17
​
18
# But sometimes you'll know better than us...
19
text-resources:
20
- path: custom/lng/*.json
21
format: formatjs-nested
22
​
23
# FlyCode adapts to your environments and branching model
24
environments:
25
- name: Development Environment
26
branch: dev
27
# We don't commit directly to your branches
28
# Pull Requests are created and managed by your team
29
mode: pull-request
30
31
- name: Production Environment
32
branch: main
33
# You don't like allowing edits directly in production, we get that :)
34
# But knowing what's there is useful
35
mode: read
36
​
37
- name: Feature Branch
38
branch: feature/**
39
# In some cases you'd might like us to commit directly to your branches
40
# to enhance collabiration during development
41
mode: write
42
​
43
# You can also display contents by tag
44
- name: Important Release
45
tag: v1.42.0
46
mode: read
Copied!
​
Copy link