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

PhET-iO design completion tasks #151

Closed
matthew-blackman opened this issue Mar 28, 2024 · 1 comment
Closed

PhET-iO design completion tasks #151

matthew-blackman opened this issue Mar 28, 2024 · 1 comment

Comments

@matthew-blackman
Copy link
Contributor

This issue is for tracking the 'After PhET-iO design has been completed...' steps in https://github.com/phetsims/phet-io/blob/main/doc/phet-io-instrumentation-technical-guide.md#post-publication-steps-after-phet-io-design-has-been-completed.

The remaining parts that we are aware of are:

  • In main, mark package.json's add "compareDesignedAPIChanges": true, to the "phet-io" section. This will add it to perennial/data/phet-io-api-stable/ (after the automatic nightly grunt generate-data). This will start CT tests and incorporate the sim for other tasks that update or check the APIs.
  • Generate the reference API by running grunt generate-phet-io-api and make sure that it is checked in to phet-io/api/.

We are confident that @pixelzoom is aware of these steps as part of #103, and are using this issue to keep a paper trail.

@pixelzoom
Copy link
Contributor

pixelzoom commented Mar 28, 2024

Thanks for this issue. On 3/13/24, I marked all 4 sims as phetioDesigned: true, added them to phet-io-api-stable, generated API files, etc. But I had neglected to add "compareDesignedAPIChanges": true to package.json. That's been done in the above commits, so I'll close this issue.

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

No branches or pull requests

2 participants