Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 0 additions & 27 deletions .github/CHANGELOG.md

This file was deleted.

38 changes: 0 additions & 38 deletions .github/DEPLOYMENT.md

This file was deleted.

116 changes: 0 additions & 116 deletions .github/DEVELOPMENT.md

This file was deleted.

2 changes: 1 addition & 1 deletion README-russian.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Forged Alliance Forever — это [проект](https://github.com/FAForever)
Список изменений
---------

Вот полный [список изменений](./.github/CHANGELOG.md). Существует [альтернативный журнал изменений](http://patchnotes.faforever.com/), особенно для патчей баланса, в удобном для пользователя виде.
Вот полный [список изменений](https://faforever.github.io/fa/development/changelog). Существует [альтернативный журнал изменений](http://patchnotes.faforever.com/), особенно для патчей баланса, в удобном для пользователя виде.

Помощь сообществу
------------
Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,17 @@ Forged Alliance Forever is a vibrant, community-driven [project](https://github.
- Log in using the account you registered and host a game with AIs and/or players, queue up for matchmaker or upload your own content to our vaults for other players to enjoy.
- Engage with the community through the [forums](https://forum.faforever.com/) using the account you registered or join us on the official [Discord server](https://discord.gg/mXahVSKGVb).

## Changelog

Over the years we continued to update the game to improve the balancing and refine mechanics. You can find the complete changelog [here](https://faforever.github.io/fa/changelog).

## Information for contributors

All contributions are expected to apply the [code of conduct](https://www.faforever.com/rules) to create a healthy and sustainable contributor environment.

- [Changelog](./.github/CHANGELOG.md): documentation about how we manage changelogs and release notes.
- [Development](./.github/DEVELOPMENT.md): documentation about development including how to setup a development environment and various best practices.
- [Deployment](./.github/DEVELOPMENT.md): documentation about deployment to the FAF, FAF Beta Balance and FAF Develop game types.
- [Changelog](https://faforever.github.io/fa/development/changelog): documentation about how we manage changelogs and release notes.
- [Development](https://faforever.github.io/fa/development): documentation about development including how to setup a development environment and various best practices.
- [Deployment](https://faforever.github.io/fa/deploy): documentation about deployment to the FAF, FAF Beta and FAF Develop game types.

In addition, there is an [extensive guide](./setup/setup-english.md) to help you setup your development environment. This guide is due to be replaced by the development file.

Expand Down
17 changes: 13 additions & 4 deletions docs/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ nav_order: 3

In this repository we can deploy to three different environments:

- `deploy/faf` - the `FAF` game type. This is the default release branch and is used by matchmaker
- `deploy/fafbeta` - the `FAF Beta Balance` game type. This branch only contains balance changes and bug fixes.
- `deploy/fafdevelop` - the `FAF Develop` game type. This branch contains all current changes that are in development.
- `deploy/faf` - the `FAF` game type. This is the default release branch and is used by the matchmaker
- `deploy/fafbeta` - the `FAF Beta` game type. This branch is for experimental changes that should not be part of `FAF Develop` for whatever reason.
- `deploy/fafdevelop` - the `FAF Develop` game type. This branch contains all current changes that are meant to be included in the next game patch.

All three branches originate from the `develop` branch, which is the default branch of the remote on Github. Pushing commits towards any of the deployment branches is sufficient to trigger a deployment to the given game type.
All three branches originate from the `develop` branch, which is the default branch of the remote on GitHub.

## Deployment procedures for the FAF game type

Expand Down Expand Up @@ -120,6 +120,15 @@ The [FAForever API](https://github.com/FAForever/faf-java-api/blob/develop/src/m

These workflows exist to apply some post processing of blueprints and various Lua modules. Not all of the post processing is implemented yet.

## Related deployments

A push to `deploy/faf` will also automatically trigger deployments of the unit databases to keep their info up-to-date:

- [Unit DB](https://github.com/FAForever/fa/blob/develop/.github/workflows/unitdb-update.yaml)
- [Spooky DB](https://github.com/FAForever/fa/blob/develop/.github/workflows/spookydb-update.yaml)
- [ETFreeman DB](https://github.com/FAForever/fa/blob/develop/.github/workflows/etfreeman-db-update.yaml)


# FAQ

## The deployment is not working
Expand Down