Document the Godot release process

godotengine / godot-docs

Godot Engine official documentation

https://docs.godotengine.org

Other

3.83k stars 3.13k forks source link

Document the Godot release process #4202

Open Calinou opened 3 years ago

Calinou commented 3 years ago

In the interest of transparency, we should document how a Godot release is made:

Which build system is used (https://github.com/godotengine/build-containers).
- Documentation on using the build containers themselves is likely better put in a README file in that repository.
How Windows binaries are signed (and soon macOS).
Which other steps are taken before a release is announced in general.

Examples:

Minetest
- This one is pretty detailed. It might be one of the best examples I know.
Visual Studio Code

This page should likely be added in the Development section.

Xrayez commented 3 years ago

If documenting the process in the official documentation is not an option, perhaps using the Wiki feature in GitHub could be a natural choice for documenting the release process, what do you think? (see linked Visual Studio Code in the OP).

Here's an example of release notes I'm using to build Godot + Goost that I have documented for my own purposes (I always forget the exact process myself): https://github.com/goostengine/godot-build-scripts/wiki/Goost-release-notes.

It takes me much less work to edit the page that way (in contrast to using git).

Calinou commented 3 years ago

If documenting the process in the official documentation is not an option, perhaps using the Wiki feature in GitHub could be a natural choice for documenting the release process, what do you think? (see linked Visual Studio Code in the OP).

We can use the official documentation just fine for this :slightly_smiling_face:

There's no problem with using Git – it's just that Akien needs some time to write this all down.

akien-mga commented 3 years ago

Well I don't see much point to document the release process in the official documentation for Godot which is translated in many languages. That's relevant only to contributors, and only to those among them who are interested in how things are done or how to replicate it. So while I think it's good to document, I don't think it should be in the RTD docs.

Calinou commented 3 years ago

If using RTD isn't suitable, perhaps a RELEASE_PROCESS.md file in godotengine/godot could work for this purpose.

Edit: I started working on such a file: https://github.com/Calinou/godot/tree/document-release-process