Update the deployment procedure #6409
Conversation
Garanas
added
the
area: documentation
|
After discussing it with @Sheikah45 , the deployment of the executable is as simple as copying whatever is the executable for FAF Develop is to the folder for FAF on the server. That means updating the executable for FAF Develop is necessary before asking the server administrators to update the executable. |
docs/deployment.md
Outdated
| You can re-use the same branch and pull request in the next phase of the deployment. | ||
|
|
||
| ### Deployment of Lua | ||
|
|
||
| The following (manual) steps are relevant to create a valid deployment to the FAF game type. | ||
| - (1) Checkout on the `changelog branch` branch created in the previous step and pull in the latest version. |
There was a problem hiding this comment.
These lines are kind of redundant now. I would just get rid of them, turning these two sections into one.
There was a problem hiding this comment.
The Lua changes are separate from the changelog thematically. Can you make a suggestion on how you'd want this part of the documentation to be?
There was a problem hiding this comment.
Ah, github doesn't let me create a suggestion here, so I'll have to do it more manually.
Replace all this
You can re-use the same branch and pull request in the next phase of the deployment.
### Deployment of Lua
- (1) Checkout on the `changelog branch` branch created in the previous step and pull in the latest version.
- (2) Update the game version in [mod_info.lua](https://github.com/FAForever/fa/blob/develop/mod_info.lua) and [version.lua](https://github.com/FAForever/fa/blob/develop/lua/version.lua).
with
- (8) Update the game version in [mod_info.lua](https://github.com/FAForever/fa/blob/develop/mod_info.lua) and [version.lua](https://github.com/FAForever/fa/blob/develop/lua/version.lua) and stage, commit and push the changes to GitHub.
Co-authored-by: BlackYps <[email protected]>
docs/deployment.md
Outdated
| - (4) Ask a server administrator to prepare the executable to be updated upon the next game release. | ||
| - - (4.1) This practically involves a copy operation where the server administrator verifies the executable of FAF Develop and copies it to a different location. | ||
|
|
||
| You can continue the deployment steps but you can not finalize it until the server administrator got back to you that it is set. This may take an arbitrary amount of time so make sure this is done well in advance. | ||
|
|
||
| ### Changelog for a deployment |
There was a problem hiding this comment.
| ### Changelog for a deployment | |
| ### Prepare the new game version |
I'd group changelog generation and preparations for the deployment of the lua files together as we process both in the same pull request.
docs/deployment.md
Outdated
| You can re-use the same branch and pull request in the next phase of the deployment. | ||
|
|
||
| ### Deployment of Lua | ||
|
|
||
| The following (manual) steps are relevant to create a valid deployment to the FAF game type. | ||
| - (1) Checkout on the `changelog branch` branch created in the previous step and pull in the latest version. |
docs/deployment.md
Outdated
| You can re-use the same branch and pull request in the next phase of the deployment. | ||
|
|
||
| ### Deployment of Lua | ||
|
|
||
| The following (manual) steps are relevant to create a valid deployment to the FAF game type. | ||
| - (1) Checkout on the `changelog branch` branch created in the previous step and pull in the latest version. |
There was a problem hiding this comment.
Ah, github doesn't let me create a suggestion here, so I'll have to do it more manually.
Replace all this
You can re-use the same branch and pull request in the next phase of the deployment.
### Deployment of Lua
- (1) Checkout on the `changelog branch` branch created in the previous step and pull in the latest version.
- (2) Update the game version in [mod_info.lua](https://github.com/FAForever/fa/blob/develop/mod_info.lua) and [version.lua](https://github.com/FAForever/fa/blob/develop/lua/version.lua).
with
- (8) Update the game version in [mod_info.lua](https://github.com/FAForever/fa/blob/develop/mod_info.lua) and [version.lua](https://github.com/FAForever/fa/blob/develop/lua/version.lua) and stage, commit and push the changes to GitHub.
| - (3) Use the [Update SpookyDB](https://github.com/FAForever/fa/actions/workflows/spookydb-update.yaml) workflow to update [SpookyDB](https://github.com/FAForever/spooky-db) | ||
| - (4) Use the [Update UnitDB](https://github.com/FAForever/fa/actions/workflows/unitdb-update.yaml) workflow to update [UnitDB](https://github.com/FAForever/UnitDB) |
There was a problem hiding this comment.
The end of the file mentions that these happen automatically. So what is correct?
There was a problem hiding this comment.
It should happen automatically, but last time it did not.
Co-authored-by: BlackYps <[email protected]>
Co-authored-by: BlackYps <[email protected]>
Co-authored-by: BlackYps <[email protected]>
|
rerequest my review when you are ready |
Description of the proposed changes
Update the deployment procedure together with @BlackYps . The majority of the steps should now be described.
For the other half of the changes, see also: a3de04d