Lists of possible joins between tables in an integration are generated automatically based on a manual list.

What is automated?

Updates in the <integration>-<version>-foreign-keys.yml files are partially automated. The keys element in the file should be updated manually. Once that is done, the tables element is then updated automatically to produce the table of all possible links between tables.

How does it work?

The Generate foreign keys GitHub Action is launched automatically any time a change to a *-foreign-keys.yml file is pushed on any branch other than master.

The job goes into all the *-foreign-keys.yml files and reads the content of the keys element, which is updated manually. From the list of keys, it creates the tables element, which contains the same content but organized by table. Each table has a list of all other tables that can be joined to it, and all elements that can be used to perform the join. This is used to create to foreign keys table displayed in the table reference documentation.

What do I need to do after the job runs?

Nothing to do! You can just merge the foreign keys updates with the rest of your changes.

Last updated: 14 March 2024