ReleaseProcess.md

Release Process

Rough notes on the steps we follow when making an SML release.

1. Add things demonstrating/testing new features to Example Mod and SMLFeatureTests when relevant

2. Ensure docs repository is updated (on https://docs-dev.ficsit.app/, at least)

3. Write version-specific Updating Guide on the docs when relevant

4. Write draft release changelog on GitHub, following the format from the previous release

5. Ensure SML VS project and mod compiles on a developer machine

6. Ensure the CI passes on the dev branch

7. Open a SML PR of dev to master and get approvals

8. Update the docs versions

   1. Create branch for old version
   2. Commit on old version branch: Set version number for version branch. Point to archived download links for SML and engine
      • See 79ae88c for example
   3. Commit on main (or dev to go into main) branch: add old version branch as another branch to build
      • See 1e7acf4 for example

9. After merging the PR, commit on master a Bump version commit

   • SML.uplugin GameVersion and SemVersion
   • ExampleMod.uplugin GameVersion and SML dependency version

10. Wait for CI to finish. We don't upload locally compiled versions so the version detailed suffix is consistent across versions.

11. While waiting for CI to finish:

    1. Merge the docs PR to master
    2. Update SMLFeatureTests SML dependency version

12. Upload CI artifact to GitHub as release. Attach all of the CI zip file contents as release items (Windows (Client), Windows Server, Linux Server, SML (multi-target))

13. Upload CI artifact to SMR as a new version of the SML mod (multi-target zip file), SMR changelog is the GitHub changelog

14. Post in #toolkit-updates and/or #announcements on Discord

15. Clear/create ficsit.app announcements as needed

    1. Get a token from your browser cookies after logging into ficsit.app

    2. Visit https://api.ficsit.app/v2

    3. Set headers to:

       {
           "Authorization": "your_token_here",
       }

    • To get active announcements, use:

      {
          getAnnouncements {
              importance
              message
              id
          }
      }

    • To create an announcement, use:

      # Query
      mutation CreateAnnouncement($announcement: NewAnnouncement!) {
          createAnnouncement(announcement: $announcement) {
              id
              message
              importance
          }
      }
      
      # Variables
      {
          "announcement": {
              "message": "Hello World",
              "importance": "Info"
          }
      }

    • To delete an announcement, use:

      # Query
      mutation DeleteAnnouncement($id: AnnouncementID!) {
          deleteAnnouncement(announcementId: $id)
      }
      
      # Variables
      {
          "id": "idFromGetGoesHere"
      }