Skip to content

Repository files navigation

VATSSA's Sector File Development Overview Repository

How to Contribute

Branch Naming Conventions

  • feature/
  • bug/
  • hotfix/
  • docs/

Commit Message Conventions

  • ([optional scope]): # subject
  • type can be feat:, fix:, style:, doc:

Current Global Plugins

TopSky

  • Stable: 2.5
  • Beta: 2.6 beta 4

GroundRadar

  • Stable: 1.5
  • Beta: 1.6 beta 6

Deploying shared files to the sector-file repos

Files every sector-file repo should carry — plugin binaries, vATIS profile data, GitHub issue templates — live here and are pushed out automatically on merge to main.

It is all controlled by one file: .github/sync.yml.

I want to… Do this
Sync a new file or folder Add one src/dest entry under sync:
Onboard a new sector-file repo Add one line under targets:
Stop syncing something Delete its entry
Remove a file from every repo Delete it here — the mirror removes it there

Nothing else needs editing. The workflow (sync-to-sectorfiles.yml) reads sync.yml and does the rest.

How it behaves

  • Folders are mirrored (rsync --delete) — add, change, or delete a file here and the same happens in every target repo. Both the stable and beta DLLs in a plugin folder are covered without listing them.
  • src and dest may differ — e.g. vatis/airports-json lands at Plugins/vATIS Profile/Airports.
  • A missing src fails the run loudly. A sync that quietly does nothing is worse than one that visibly breaks.
  • Repos sync independently (fail-fast: false) — one broken repo never blocks the other 24. Each repo is serialised against itself, and a rejected push rebases and retries once.
  • Only changed repos get a commit; the rest report "already up to date".
  • Run it by hand any time from the Actions tab (workflow_dispatch). Safe — it only pushes where something actually differs.

Current Sector File Repositories

This list is documentation for humans. The list the automation actually uses is targets: in .github/sync.yml — keep the two in step.

About

VATSSA's Sector File Development Overview Repository

Resources

Stars

2 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages