chore: Added workflow for generating compatibility doc #2183
Conversation
| branches: | ||
| - main | ||
| paths: | ||
| - 'test/versioned/**/package.json' |
There was a problem hiding this comment.
so this is just saying re-run automatically when we add new versioned tests for a library. This seems very rare and more importantly would this run on a scheduled basis because the newer versions of a given library we instrument happens frequently. also, I'd see this getting run on release right?
You may want to add this like post release or but this in there right?
workflows: ["Create Release"]
types:
- completed
There was a problem hiding this comment.
This is saying: "every time a push to the main branch occurs (i.e. a pull request was merged into main), and there have been changes to any package.json file that resides under test/versioned/, run the workflow".
We can add a scheduled run of this if it is desired. It would be a separate "on" block like the workflow_dispatch block.
This PR resolves #2178. The result will be: after any PR is merged to
mainthat contains changes to any json files undertest/versioned/a new PR will be automatically opened that updates thecompatibility.mddocument in the root of the repository.The workflow can also be triggered manually.
The automatic PR will continually update the same branch+PR until such time as that PR has been merged. Subsequent changes will result in new PRs.