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

Include a sample JSON file generated by each new release, with the release #789

Open
dhmay opened this issue Nov 12, 2024 · 2 comments
Open

Comments

@dhmay
Copy link

dhmay commented Nov 12, 2024

Is your feature request related to a problem? Please describe.
When a new version of the scoreboard is released, it has the potential to break JamStats. It can take me a while to install the new version and generate a test file to find breaking changes. More frequently, I learn about a breaking change in a JamStats bug report.

Describe the solution you'd like
With each release, programmatically generate a JSON file representing a complete derby game, and include it with the release.

Describe alternatives you've considered
Waiting for people to report JamStats bugs, installing the new CRG release and making a dummy game file myself.

Additional context
I'm not sure how many other tools there are out there that work with the JSON, but presumably it'd benefit them, too.

@frank-weinberg
Copy link
Contributor

Several thoughts:

  • I don't think the release zip is a good place to put such files. They'd make more sense in some sort of central repository IMO.
  • It is pretty straightforward to convert an existing game file to the newest version by just importing and reexporting it. But that game will not use any new features, so presumably a significant subset of issues wouldn't be found. And generating a game that uses new features programmatically would require the generator to be adjusted for each new version, mostly killing the advantage of the "programmatically" part.
  • For proactively adapting to changes wouldn't it be easier to search for the new version in https://github.com/rollerderby/scoreboard/wiki/WebSocket-Channels and work from that instead of reverse engineering the changes from a JSON?

@dhmay
Copy link
Author

dhmay commented Nov 12, 2024

  • I agree, a central repository would make more sense than the release zip. When I suggested the release zip I was thinking mainly about what seemed to me like it would be easy for you to generate.
  • Yes, converting an existing game file or, better yet, generating one that exercised new features, would be a more thorough way to test JamStats compatibility. And proactively adapting to new changes would be a more thorough way to stay up to date. But my first priority is just keeping the lights on. What I'd like is a file that lets me easily do a smoke test, without installing the new version of CRG. Basically, a "does JamStats totally barf on this new version" test. If it doesn't barf, I can adapt at my leisure. If it barfs, I need to go into bugfix mode right away.

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

No branches or pull requests

2 participants