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

Doc: Add guide to releasing OpenTTD #10563

Merged
merged 1 commit into from Mar 26, 2023
Merged

Conversation

2TallTyler
Copy link
Member

@2TallTyler 2TallTyler commented Mar 11, 2023

Motivation / Problem

@michicc wrote a really nice guide to releasing OpenTTD in a series of Discord posts. Let's not lose it.

Description

I adapted the guide to the best of my understanding. Please ensure it's correct and suggest anything I've missed or misworded. I'm inviting you to nit-pick. 😃

Limitations

Checklist for review

Some things are not automated, and forgotten often. This list is a reminder for the reviewers.

  • The bug fix is important enough to be backported? (label: 'backport requested')
  • This PR touches english.txt or translations? Check the guidelines
  • This PR affects the save game format? (label 'savegame upgrade')
  • This PR affects the GS/AI API? (label 'needs review: Script API')
    • ai_changelog.hpp, gs_changelog.hpp need updating.
    • The compatibility wrappers (compat_*.nut) need updating.
  • This PR affects the NewGRF API? (label 'needs review: NewGRF')

@2TallTyler 2TallTyler force-pushed the release-guide branch 2 times, most recently from e4a2adc to 7d99cee Compare March 11, 2023 19:08
@frosch123
Copy link
Member

Here is the previous version of the release guide: https://wiki.openttd.org/en/Development/Doing%20an%20OpenTTD%20release
The part on "After creating a branch for a new version" got lost in this PR.

I think there should only be one guide, delete the wiki page afterwards?

@2TallTyler
Copy link
Member Author

2TallTyler commented Mar 25, 2023

Some steps I'm unclear about, from the linked release guide:

  • run "make regression" — Is still still required? How is this done?
  • Poke package maintainers on IRC: blathijs (debian), heffer (fedora). — Do we still do this now that we only offer the generic Linux build?

@rubidium42
Copy link
Contributor

* `run "make regression"` — Is still still required? How is this done?

At least the CI runs it automatically, so if it builds it should be fine. Not sure how it's done in MSVC, but when using make it's still literally make regression instead of make.

* `Poke package maintainers on IRC: blathijs (debian), heffer (fedora).` — Do we still do this now that we only offer the generic Linux build?

This is about the upstream maintainers. They are the ones that update the package that is in the Debian/Fedora (derived) distributions. Practically it's not much more than 'blathijs, heffer: new release', although I don't think heffer is on our IRC channel. And I've not seen a poke recently, so I guess it could be left out. It used to be a courtesy thing in the past.

@glx22
Copy link
Contributor

glx22 commented Mar 25, 2023

* `run "make regression"` — Is still still required? How is this done?

At least the CI runs it automatically, so if it builds it should be fine. Not sure how it's done in MSVC, but when using make it's still literally make regression instead of make.

For MSVC it's under Test menu (when using "open directory" mode).
Anyway regression is a required CI check, only admins could force merge a PR with broken regression.

@michicc michicc merged commit e26d3de into OpenTTD:master Mar 26, 2023
19 checks passed
@2TallTyler 2TallTyler deleted the release-guide branch March 26, 2023 14:48
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants