Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Separate release flavors from core cadesim code #117

Open
plaza-in-a-heatwave opened this issue Nov 4, 2020 · 1 comment
Open

Separate release flavors from core cadesim code #117

plaza-in-a-heatwave opened this issue Nov 4, 2020 · 1 comment
Labels
Client Issues affecting cadesim Client documentation Improvements or additions to documentation enhancement New feature or request Server Issues affecting cadesim Server
Milestone

Comments

@plaza-in-a-heatwave
Copy link
Owner

Problems

  • Core functionality is tied to one release flavor
  • Adapting to other flavors will be more difficult

Current situation:

  • All code releases geared toward one flavor at the moment
  • Some files (user.config, getdown.txt) are specific to the flavor
  • This flavor is hosted on the repo (release branch).
  • Code is deployed with ./deploy.bash flavorname which is on the main branch

Design criteria

  • Core code is flavor-neutral
  • Allows other flavors to be hosted on git or some other host, flexibly
  • Should provide a way to build flavor-specific releases, but these should sit in a different branch.
  • Should host flavor-specific backgrounds, images, overlays, but these should sit in a different branch.
  • Shouldn't host flavor-specific config - this should go in an installer
  • Shouldn't create installers - this should be done by the owner of the specific flavor separate to this repo.

Proposed:

  • Different branches, one per flavor. e.g. flavor-growup
  • getdown.txt will contain the host URL on these branches.
  • user.config will be generic in the main branch and the flavor branches. It will be specific only in the installer.
  • Flavors can optionally be hosted on this repo (release branch) or another host (getdown URL changes)
  • specific deployment scripts on each flavor branch, e.g. ./deploy.bash rather than ./deploy.bash flavorname

Affected files/aspects:

  • branching
  • user.config, getdown.txt
  • deploy.bash
  • flavor-specific backgrounds, images, overlays
@plaza-in-a-heatwave plaza-in-a-heatwave added documentation Improvements or additions to documentation enhancement New feature or request Client Issues affecting cadesim Client Server Issues affecting cadesim Server labels Nov 4, 2020
@plaza-in-a-heatwave plaza-in-a-heatwave added this to the 1.9.94 milestone Nov 4, 2020
@plaza-in-a-heatwave
Copy link
Owner Author

plaza-in-a-heatwave commented Nov 5, 2020

user.config is no longer a required resource as of 309457d, so this may no longer need to be flavor specific. Related: #119 might result in an additional file for server config, which would be flavor specific.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Client Issues affecting cadesim Client documentation Improvements or additions to documentation enhancement New feature or request Server Issues affecting cadesim Server
Projects
None yet
Development

No branches or pull requests

1 participant