Skip to main content

Deployment

When the library version is finished, tested and ready to be deployed, the following steps should be followed:

  1. Checkout the release branch created in the implementation phase
  2. Make sure all tests are passing
    • For the distribution file
    • For the minified distribution file
  3. Generate the LuaDocs files and push them to the repository with "Update LuaDocs" as the commit message
  4. Open the documentation/docs/changelog.md file and update the release date placeholder with the current date and push it to the repository with "Update vx.y.z release date" (of course, replacing x.y.z with the current version being deployed)
  5. Go to the release PR in GitHub, take a quick look at the changes, and merge it
  6. Create a new release:
    • The tag name is the raw version number, like 1.0.0
    • The release title is the same, but with a v prefix, like v1.0.0
    • The release notes are created with the Generate release notes button
    • Important: Upload both dist/stormwind-library.lua and dist/stormwind-library.min.lua compiled files release assets
  7. Checkout the main branch and pull the latest changes
  8. Deploy the documentation to GitHub Pages using the npm commands described here
    • Check the GitHub actions page and wait until the page build and deployment job is finished to have all the changes available in the live documentation