deadlock-wiki / deadbot

Repository to handle any scripting and automation for the Deadlock Wiki
MIT License
9 stars 3 forks source link

Github action to generate and upload parsed game data #64

Open hassayag opened 2 days ago

hassayag commented 2 days ago

Automation of the game file parsing will reduce the manual work for maintaining up to date output.

Additionally, this data should be stored in a separate repo in order to keep the PRs on the deadbot repo cleaner. We want to migrate it to the new deadlock-data repo which will store a snapshot of the current patch.

Acceptance Criteria Github action to run as workflow dispatch or merge to develop and master branches to do the following:

hassayag commented 2 days ago

Potential issue - investigating what a PR does is not as easy when you don't have the proof of the output data changing as you'd expect, but that can still be handled locally if you have cloned the deadlock-data repo

This isn't ideal, so I am going to look at potentially generating a diff as a file in the CI, letting you review changes, but without muddying the diff

B13rg commented 2 days ago

I think the current data should stay in this repo, and then replicated to the other.I also like having the diff to know stuff worked correctly. I guess it depends which repo we want to be the primary source of truth. If all the automation for updating moves to the deadlock-data repo, then it's like you said show example output as an artifact just to confirm the bot works, and move all the "production" data handling to the other repo

B13rg commented 1 day ago

For now I've setup https://github.com/deadlock-wiki/deadlock-data/blob/main/.github/workflows/scheduled-sync.yml to pull data over to that repo, we can see how it behaves over the next few updates. It basically checks out the latest deadbot main branch and copies over the game data.

Since this repo is added as a submodule in deadlock-data, it'll point directly to the repo commit that generated the files.