Implement GitHub Actions workflow for automatically updating the example JSON files

[cebe]

As discussed in #1385 the example .json files for version 3 should be automatically generated from the .yaml example files.

I thought this was a good case for trying out Github Actions and the result is the following:

• When a push to master (or any other branch we wish to include) is made, a Github Actions Workflow is triggered (example)
• it will generate new JSON files from the YAML examples
• if there are any changes, it will create a pull request to the branch that triggered the Workflow (example)

[webron]

Huh, this is awesome. Would it make sense to change the Action to run on *.yaml in that directory instead?

[webron]

Is that still needed? :)

[cebe]

probably not, going to remove that before merging this PR. But it will run the action if I make adjustments to this branch so I'd keep it for testing until it is ready to merge.

[cebe]

Would it make sense to change the Action to run on *.yaml in that directory instead?

what do you mean? As far as I am aware there is no way to run an action based on whether some files changed or not.

[cebe]

@webron is there anything to change or to do from my side to get this merged? (except from removing the try-github-actions branch)

[webron]

Sorry, I didn't mean run it based on whether a file changed, but rather here:

        vendor/bin/php-openapi convert --read-yaml callback-example.yaml  --write-json callback-example.json
        vendor/bin/php-openapi convert --read-yaml link-example.yaml      --write-json link-example.json
        vendor/bin/php-openapi convert --read-yaml petstore.yaml          --write-json petstore.json
        vendor/bin/php-openapi convert --read-yaml petstore-expanded.yaml --write-json petstore-expanded.json
        vendor/bin/php-openapi convert --read-yaml uspto.yaml             --write-json uspto.json

instead of running it on each file individually, it'd be more robust if it ran on all yaml file in the directory, in case additional files are added.

[MikeRalphson]

Also, what indentation is used in the output json? I guess it should match the v2.0 examples for consistency.

[cebe]

Indentation is currently 4 spaces, I'll change that to 2.

[MikeRalphson]

@cebe is the exclusion due to #2036 ?

Just a thought for after this is merged, would you have time to create a similar workflow to keep the json versions of the yaml json-schemas in step? It would need to run on versions (directories) 3.0 and above.

[cebe]

@cebe is the exclusion due to #2036 ?

yes, symfony/yaml has some problems with these files, did not see that PR, will try to merge the commit and see if it fixes the problem.

Just a thought for after this is merged, would you have time to create a similar workflow to keep the json versions of the yaml json-schemas in step? It would need to run on versions (directories) 3.0 and above.

sure I can do that.

[cebe]

Merged the changes from #2036, they fix the issue with api-with-examples.yaml.

instead of running it on each file individually, it'd be more robust if it ran on all yaml file in the directory, in case additional files are added.

done.

Also, what indentation is used in the output json? I guess it should match the v2.0 examples for consistency.

indentation is 2 now.

Ready to merge from my side.

[webron]

I'm ok with the changes. @MikeRalphson please verify as well. If It's all good, we need to remove the test branch from the script and then merge it.

[MikeRalphson]

My only question is why we indent the target with tabs and then (presumably) overwrite it with a space indented version. Otherwise LGTM.

[cebe]

My only question is why we indent the target with tabs and then (presumably) overwrite it with a space indented version.

The tool I use for indentation can not convert 4 space to 2 space indentation. it can only convert tabs to spaces or spaces to tabs. So I do the conversion in two steps, 4 spaces to tabs, then tabs to 2 spaces.

[cebe]

we need to remove the test branch from the script

done.

[MikeRalphson]

@webron are you ok to create the GITHUB_TOKEN before merging?

[webron]

@MikeRalphson If I understand correctly, GITHUB_TOKEN is created automatically when GitHub Actions are enabled (which they are). See https://help.github.com/en/actions/automating-your-workflow-with-github-actions/authenticating-with-the-github_token.

[MikeRalphson]

👍

[cebe]

there is no need to add a github token manually, it is provided by Github actions. Anything stopping this from being merged?

[cebe]

Closing this, as #2199 is replacing it.