Skip to content

Latest commit

 

History

History
71 lines (67 loc) · 2.73 KB

RELEASES.md

File metadata and controls

71 lines (67 loc) · 2.73 KB

Testing checklist

  • When you open clarity with DQX closed, does the "Important Notice" text get found?
    • If no, check:
      • common.process.wait_for_dqx_to_launch
      • common.signatures.notice_string
  • Do player nameplates translate?
    • If no, check:
      • clarity.scan_for_player_names
      • common.signatures.player_name_pattern
  • Do NPC, monster and party name nameplates translate?
    • If no, check:
      • clarity.scan_for_npc_names
      • common.signatures.npc_monster_pattern
  • Do concierge names translate?
    • If no, check:
      • clarity.scan_for_concierge_names
      • common.signatures.concierge_name_pattern
  • Does the player's sibling name translate?
    • If no, check:
      • clarity.scan_for_sibling_name
      • common.signatures.sibling_name_pattern
  • Do the party members on the right side of the screen translate?
    • If no, check:
      • clarity.scan_for_menu_ai_names
      • common.signatures.menu_ai_name_pattern
  • Do player names in the communication window translate? (team, friends)
    • If no, check:
      • clarity.scan_for_menu_ai_names
      • common.signatures.comm_name_pattern_1
      • common.signatures.comm_name_pattern_2
  • Does the player's walkthrough text in the command menu translate?
    • If no, check:
      • clarity.loop_scan_for_walkthrough
      • common.signatures.walkthrough_pattern
  • When you talk to an NPC, does it translate into English (from the database)?
    • Make sure the text is in the database when testing
    • If no, check:
      • logs/console.log
      • hooking.dialog
  • When you talk to an NPC, does it translate into English (from a translate API)?
    • Make sure the text isn't in the database when testing
    • If no, check:
      • logs/console.log
      • hooking.dialog
  • Does master quest description text translate?
    • If no, check:
      • logs/console.log
      • hooking.network_text
  • Does story so far translate?
    • If no, check:
      • logs/console.log
      • hooking.network_text
  • Do quest descriptions translate?
    • If no, check:
      • logs/console.log
      • hooking.quest

Release instructions

Releases are performed through Github Action workflows.

  • All changes expected to be released should exist in main
  • Ensure you have pulled down the latest main branch
    • git pull origin main
  • Create a new tag (make sure to prepend the tag with "v")
    • git tag <version> (ex: git tag v4.0.0)
  • Push the tag up
    • git push origin <version> (ex: git push origin v4.0.0)
  • This will trigger a Github Action named build-release-zip
  • After a minute or two, you'll see a new release generated with the tag that was pushed up