Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Github action to generate and upload parsed game data #64

Open
hassayag opened this issue Oct 3, 2024 · 3 comments
Open

Github action to generate and upload parsed game data #64

hassayag opened this issue Oct 3, 2024 · 3 comments
Assignees
Labels
infra Codebase infrastructure changes

Comments

@hassayag
Copy link
Member

hassayag commented Oct 3, 2024

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:

  • Read decompiled game data from s3 and run the parser to generate the output data
  • Upon merge, it will commit to the same branch on deadlock-data repo with a reference to the PR number in the commit message
@hassayag hassayag added the infra Codebase infrastructure changes label Oct 3, 2024
@hassayag hassayag changed the title Migrate output-data to deadlock-data repo Github action to generate and upload parsed game data Oct 3, 2024
@hassayag
Copy link
Member Author

hassayag commented Oct 3, 2024

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
Copy link
Contributor

B13rg commented Oct 3, 2024

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
Copy link
Contributor

B13rg commented Oct 4, 2024

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
infra Codebase infrastructure changes
Projects
None yet
Development

When branches are created from issues, their pull requests are automatically linked.

2 participants