hhvm / hh-apidoc

An API documentation generator for Hack files, which start with 'hh'.
MIT License
10 stars 7 forks source link

Add a GitHub Action step to create a pull request to report generated code changes #51

Closed Atry closed 2 years ago

Atry commented 2 years ago

Previously a CI error would be reported if any change in generated code is found.

The behavior is undesired because the difference between HHVM might be expected sometimes. For example, the HTML format changes in newer HHVM versions.

This PR creates a Github Action step to create a pull request to report generated code changes instead of reporting errors. For example: https://github.com/Atry/hh-apidoc/pull/4 is created the Github Action step introduced by this PR. The new approach would be better because the oncall engineer would have a chance to review the change.

Atry commented 2 years ago

The commit be5fe3a0daf84d3f2985bb3d0a98b7175b755875 is created by merging https://github.com/Atry/hh-apidoc/pull/4 , which is created from https://github.com/Atry/hh-apidoc/actions/runs/2557546252