Update workflows and readmes

Numynum · Numynum · commit b9b27d3e2dd2 · 2025-05-03T17:14:20.000+02:00
diff --git a/.github/workflows/beta.yml b/.github/workflows/beta.yml
@@ -6,8 +6,17 @@ on:
     - cron: '*/15 * * * *'
 
 jobs:
-  build:
+  beta:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: beta
       FLAVOR: mainline
+
+  beta-mix-into-source:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: beta
+      FLAVOR: mainline
+      TARGET_BRANCH_SUFFIX: '-mix-into-source'
+      MIX_ANNOTATIONS_INTO_SOURCE: true
+      INCLUDE_RAW_XML_SOURCE: true
diff --git a/.github/workflows/classic.yml b/.github/workflows/classic.yml
@@ -6,8 +6,17 @@ on:
     - cron: '*/15 * * * *'
 
 jobs:
-  build:
+  classic:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: classic
       FLAVOR: cata
+
+  classic-mix-into-source:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: classic
+      FLAVOR: cata
+      TARGET_BRANCH_SUFFIX: '-mix-into-source'
+      MIX_ANNOTATIONS_INTO_SOURCE: true
+      INCLUDE_RAW_XML_SOURCE: true
diff --git a/.github/workflows/classic_beta.yml b/.github/workflows/classic_beta.yml
@@ -1,16 +1,22 @@
-name: live-mix-into-source
+name: classic_ptr
 
 on:
   workflow_dispatch:
   schedule:
     - cron: '*/15 * * * *'
 
 jobs:
-  build:
+  classic_beta:
     uses: ./.github/workflows/template.yml
     with:
-      BRANCH: live
+      BRANCH: classic_beta
+      FLAVOR: mists
+
+  classic_beta-mix-into-source:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: classic_beta
+      FLAVOR: mists
       TARGET_BRANCH_SUFFIX: '-mix-into-source'
-      FLAVOR: mainline
       MIX_ANNOTATIONS_INTO_SOURCE: true
       INCLUDE_RAW_XML_SOURCE: true
diff --git a/.github/workflows/classic_era.yml b/.github/workflows/classic_era.yml
@@ -6,8 +6,17 @@ on:
     - cron: '*/15 * * * *'
 
 jobs:
-  build:
+  classic_era:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: classic_era
       FLAVOR: vanilla
+
+  classic_era-mix-into-source:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: classic_era
+      FLAVOR: vanilla
+      TARGET_BRANCH_SUFFIX: '-mix-into-source'
+      MIX_ANNOTATIONS_INTO_SOURCE: true
+      INCLUDE_RAW_XML_SOURCE: true
diff --git a/.github/workflows/classic_era_ptr.yml b/.github/workflows/classic_era_ptr.yml
@@ -6,8 +6,17 @@ on:
     - cron: '*/15 * * * *'
 
 jobs:
-  build:
+  classic_era_ptr:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: classic_era_ptr
       FLAVOR: vanilla
+
+  classic_era_ptr-mix-into-source:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: classic_era_ptr
+      FLAVOR: vanilla
+      TARGET_BRANCH_SUFFIX: '-mix-into-source'
+      MIX_ANNOTATIONS_INTO_SOURCE: true
+      INCLUDE_RAW_XML_SOURCE: true
diff --git a/.github/workflows/classic_ptr.yml b/.github/workflows/classic_ptr.yml
@@ -6,8 +6,17 @@ on:
     - cron: '*/15 * * * *'
 
 jobs:
-  build:
+  classic_ptr:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: classic_ptr
       FLAVOR: cata
+
+  classic_ptr-mix-into-source:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: classic_ptr
+      FLAVOR: cata
+      TARGET_BRANCH_SUFFIX: '-mix-into-source'
+      MIX_ANNOTATIONS_INTO_SOURCE: true
+      INCLUDE_RAW_XML_SOURCE: true
diff --git a/.github/workflows/force_update_all.yml b/.github/workflows/force_update_all.yml
@@ -8,64 +8,151 @@ jobs:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: live
-      FORCE_UPDATE: true
       FLAVOR: mainline
+      FORCE_UPDATE: true
 
   live-mix-into-source:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: live
-      TARGET_BRANCH_SUFFIX: '-mix-into-source'
-      FORCE_UPDATE: true
       FLAVOR: mainline
+      FORCE_UPDATE: true
+      TARGET_BRANCH_SUFFIX: '-mix-into-source'
       MIX_ANNOTATIONS_INTO_SOURCE: true
       INCLUDE_RAW_XML_SOURCE: true
 
   ptr:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: ptr
+      FLAVOR: mainline
       FORCE_UPDATE: true
+
+  ptr-mix-into-source:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: ptr
       FLAVOR: mainline
+      TARGET_BRANCH_SUFFIX: '-mix-into-source'
+      MIX_ANNOTATIONS_INTO_SOURCE: true
+      INCLUDE_RAW_XML_SOURCE: true
+      FORCE_UPDATE: true
 
   ptr2:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: ptr2
+      FLAVOR: mainline
       FORCE_UPDATE: true
+
+  ptr2-mix-into-source:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: ptr2
       FLAVOR: mainline
+      TARGET_BRANCH_SUFFIX: '-mix-into-source'
+      MIX_ANNOTATIONS_INTO_SOURCE: true
+      INCLUDE_RAW_XML_SOURCE: true
+      FORCE_UPDATE: true
 
   beta:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: beta
+      FLAVOR: mainline
       FORCE_UPDATE: true
+
+  beta-mix-into-source:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: beta
       FLAVOR: mainline
+      TARGET_BRANCH_SUFFIX: '-mix-into-source'
+      MIX_ANNOTATIONS_INTO_SOURCE: true
+      INCLUDE_RAW_XML_SOURCE: true
+      FORCE_UPDATE: true
 
   classic:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: classic
+      FLAVOR: cata
       FORCE_UPDATE: true
+
+  classic-mix-into-source:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: classic
       FLAVOR: cata
+      TARGET_BRANCH_SUFFIX: '-mix-into-source'
+      MIX_ANNOTATIONS_INTO_SOURCE: true
+      INCLUDE_RAW_XML_SOURCE: true
+      FORCE_UPDATE: true
 
   classic_ptr:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: classic_ptr
+      FLAVOR: cata
       FORCE_UPDATE: true
+
+  classic_ptr-mix-into-source:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: classic_ptr
       FLAVOR: cata
+      TARGET_BRANCH_SUFFIX: '-mix-into-source'
+      MIX_ANNOTATIONS_INTO_SOURCE: true
+      INCLUDE_RAW_XML_SOURCE: true
+      FORCE_UPDATE: true
+
+  classic_beta:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: classic_beta
+      FLAVOR: mists
+      FORCE_UPDATE: true
+
+  classic_beta-mix-into-source:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: classic_beta
+      FLAVOR: mists
+      TARGET_BRANCH_SUFFIX: '-mix-into-source'
+      MIX_ANNOTATIONS_INTO_SOURCE: true
+      INCLUDE_RAW_XML_SOURCE: true
+      FORCE_UPDATE: true
 
   classic_era:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: classic_era
+      FLAVOR: vanilla
       FORCE_UPDATE: true
+
+  classic_era-mix-into-source:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: classic_era
       FLAVOR: vanilla
+      TARGET_BRANCH_SUFFIX: '-mix-into-source'
+      MIX_ANNOTATIONS_INTO_SOURCE: true
+      INCLUDE_RAW_XML_SOURCE: true
+      FORCE_UPDATE: true
 
   classic_era_ptr:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: classic_era_ptr
+      FLAVOR: vanilla
       FORCE_UPDATE: true
+
+  classic_era_ptr-mix-into-source:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: classic_era_ptr
       FLAVOR: vanilla
+      TARGET_BRANCH_SUFFIX: '-mix-into-source'
+      MIX_ANNOTATIONS_INTO_SOURCE: true
+      INCLUDE_RAW_XML_SOURCE: true
+      FORCE_UPDATE: true
diff --git a/.github/workflows/live.yml b/.github/workflows/live.yml
@@ -6,8 +6,17 @@ on:
     - cron: '*/15 * * * *'
 
 jobs:
-  build:
+  live:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: live
       FLAVOR: mainline
+
+  live-mix-into-source:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: live
+      TARGET_BRANCH_SUFFIX: '-mix-into-source'
+      FLAVOR: mainline
+      MIX_ANNOTATIONS_INTO_SOURCE: true
+      INCLUDE_RAW_XML_SOURCE: true
diff --git a/.github/workflows/ptr.yml b/.github/workflows/ptr.yml
@@ -6,8 +6,17 @@ on:
     - cron: '*/15 * * * *'
 
 jobs:
-  build:
+  ptr:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: ptr
       FLAVOR: mainline
+
+  ptr-mix-into-source:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: ptr
+      FLAVOR: mainline
+      TARGET_BRANCH_SUFFIX: '-mix-into-source'
+      MIX_ANNOTATIONS_INTO_SOURCE: true
+      INCLUDE_RAW_XML_SOURCE: true
diff --git a/.github/workflows/ptr2.yml b/.github/workflows/ptr2.yml
@@ -6,8 +6,17 @@ on:
     - cron: '*/15 * * * *'
 
 jobs:
-  build:
+  ptr2:
     uses: ./.github/workflows/template.yml
     with:
       BRANCH: ptr2
       FLAVOR: mainline
+
+  ptr2-mix-into-source:
+    uses: ./.github/workflows/template.yml
+    with:
+      BRANCH: ptr2
+      FLAVOR: mainline
+      TARGET_BRANCH_SUFFIX: '-mix-into-source'
+      MIX_ANNOTATIONS_INTO_SOURCE: true
+      INCLUDE_RAW_XML_SOURCE: true
diff --git a/README.md b/README.md
@@ -1,15 +1,18 @@
-Status: beta
+This repository is configured to automatically pull the latest version of [Gethe/wow-ui-source](https://github.com/Gethe/wow-ui-source/), 
+and generate annotations from all files relevant for the specific flavor.
+
+There's also a set of branches which include the full original FrameXML source code, including both the original XML files, and Lua files with annotations added into the files themselves (the line numbers will still match the original files).
 
-This repository is configured to automatically pull the latest version of [Gethe/wow-ui-source](https://github.com/Gethe/wow-ui-source/), and generate annotations from _all_ files.
 Currently, the annotations are generated for the following branches:
-  - Annotations/[live](https://github.com/NumyAddon/FramexmlAnnotations/tree/live) Gethe/[live](https://github.com/gethe/wow-ui-source/tree/live)
-  - Annotations/[ptr](https://github.com/NumyAddon/FramexmlAnnotations/tree/ptr) Gethe/[ptr](https://github.com/gethe/wow-ui-source/tree/ptr)
-  - Annotations/[ptr2](https://github.com/NumyAddon/FramexmlAnnotations/tree/ptr2) Gethe/[ptr2](https://github.com/gethe/wow-ui-source/tree/ptr2)
-  - Annotations/[beta](https://github.com/NumyAddon/FramexmlAnnotations/tree/beta) Gethe/[beta](https://github.com/gethe/wow-ui-source/tree/beta)
-  - Annotations/[classic](https://github.com/NumyAddon/FramexmlAnnotations/tree/classic) Gethe/[classic](https://github.com/gethe/wow-ui-source/tree/classic)
-  - Annotations/[classic_ptr](https://github.com/NumyAddon/FramexmlAnnotations/tree/classic_ptr) Gethe/[classic_ptr](https://github.com/gethe/wow-ui-source/tree/classic_ptr)
-  - Annotations/[classic_era](https://github.com/NumyAddon/FramexmlAnnotations/tree/classic_era) Gethe/[classic_era](https://github.com/gethe/wow-ui-source/tree/classic_era)
-  - Annotations/[classic_era_ptr](https://github.com/NumyAddon/FramexmlAnnotations/tree/classic_era_ptr) Gethe/[classic_era_ptr](https://github.com/gethe/wow-ui-source/tree/classic_era_ptr)
+  - Annotations/[live](https://github.com/NumyAddon/FramexmlAnnotations/tree/live) Annotations/[live-mix-into-source](https://github.com/NumyAddon/FramexmlAnnotations/tree/live-mix-into-source) Gethe/[live](https://github.com/gethe/wow-ui-source/tree/live)
+  - Annotations/[ptr](https://github.com/NumyAddon/FramexmlAnnotations/tree/ptr) Annotations/[ptr-mix-into-source](https://github.com/NumyAddon/FramexmlAnnotations/tree/ptr-mix-into-source) Gethe/[ptr](https://github.com/gethe/wow-ui-source/tree/ptr)
+  - Annotations/[ptr2](https://github.com/NumyAddon/FramexmlAnnotations/tree/ptr2) Annotations/[ptr2-mix-into-source](https://github.com/NumyAddon/FramexmlAnnotations/tree/ptr2-mix-into-source) Gethe/[ptr2](https://github.com/gethe/wow-ui-source/tree/ptr2)
+  - Annotations/[beta](https://github.com/NumyAddon/FramexmlAnnotations/tree/beta) Annotations/[beta-mix-into-source](https://github.com/NumyAddon/FramexmlAnnotations/tree/beta-mix-into-source) Gethe/[beta](https://github.com/gethe/wow-ui-source/tree/beta)
+  - Annotations/[classic](https://github.com/NumyAddon/FramexmlAnnotations/tree/classic) Annotations/[classic-mix-into-source](https://github.com/NumyAddon/FramexmlAnnotations/tree/classic-mix-into-source) Gethe/[classic](https://github.com/gethe/wow-ui-source/tree/classic)
+  - Annotations/[classic_ptr](https://github.com/NumyAddon/FramexmlAnnotations/tree/classic_ptr) Annotations/[classic_ptr-mix-into-source](https://github.com/NumyAddon/FramexmlAnnotations/tree/classic_ptr-mix-into-source) Gethe/[classic_ptr](https://github.com/gethe/wow-ui-source/tree/classic_ptr)
+  - Annotations/[classic_beta](https://github.com/NumyAddon/FramexmlAnnotations/tree/classic_beta) Annotations/[classic_beta-mix-into-source](https://github.com/NumyAddon/FramexmlAnnotations/tree/classic_beta-mix-into-source) Gethe/[classic_ptr](https://github.com/gethe/wow-ui-source/tree/classic_beta)
+  - Annotations/[classic_era](https://github.com/NumyAddon/FramexmlAnnotations/tree/classic_era) Annotations/[classic_era-mix-into-source](https://github.com/NumyAddon/FramexmlAnnotations/tree/classic_era-mix-into-source) Gethe/[classic_era](https://github.com/gethe/wow-ui-source/tree/classic_era)
+  - Annotations/[classic_era_ptr](https://github.com/NumyAddon/FramexmlAnnotations/tree/classic_era_ptr) Annotations/[classic_era_ptr-mix-into-source](https://github.com/NumyAddon/FramexmlAnnotations/tree/classic_era_ptr-mix-into-source) Gethe/[classic_era_ptr](https://github.com/gethe/wow-ui-source/tree/classic_era_ptr)
 
 Generated annotations are limited to
  - Frames
@@ -19,11 +22,11 @@ Generated annotations are limited to
    - Limited support for inheritance, children, and <KeyValues>
  - Globals with a name ending in `Mixin`; some mixins may be missing
    - "methods" for a given mixin
-   - inheritence through `CreateFromMixins`
- - Global functions
-   - for now disabled, using Ketho's annotations, and including the wow source as workspace libraries is probably better
+   - inheritance through `CreateFromMixins`
+
+Disclaimer: Generated annotations by their very nature are not 100% accurate and may be imprecise or missing altogether.
 
-prerequisites to run this yourself:
+Prerequisites to run this yourself:
 - PHP 8.3
    - ext-xml
    - ext-dom
diff --git a/annotation_branch_readme.md b/annotation_branch_readme.md
