-
Notifications
You must be signed in to change notification settings - Fork 33
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
Stop auto-commits to website/src/pages/docs/schema-reference.md #997
Comments
To do this I:
|
- `json-dereference` always return 0, even in case of syntax error - to overcome this limitation we check if temporary schema.json file is generated
* (#997) stop automatic git commits of schema-reference.md. * (#997) Add validation for `json-dereference` operation - `json-dereference` always return 0, even in case of syntax error - to overcome this limitation we check if temporary schema.json file is generated * (#997) Add schema2md.js to the list of triggers for github workflow. Co-authored-by: michalbiesek <mbiesek@cribl.io>
Since this ticket was affecting github, after merging this PR, I did some additional testing, aimed at verifying that the changes made here were having the appropriate effect in github. To test that the file has been removed from git:
returned this for the ls -al command:
This confirms that the schema-reference.md is no longer controlled in git. To make sure that the website schema generation still works end-to-end, I looked at https://appscope.dev/docs/schema-reference/#eventhttpresp after @seanvaleo published a new tag web-1.1.0-update2. This tells me that the website is still fully functional, despite the fact that schema-reference.md is no longer in git. This also implies that the With this much working, I chose to not explicitly test that we have the right set of triggers for website.yml: |
In #880, we added the ability to automatically generate the schema-reference.md file. As the last step of this processing we set up in this ticket, the github pipeline does a git commit and push of the generated schema-reference.md file.
The source *.schema.json files that are used to create schema-reference.md are all controlled in git. With the source schema.json files controlled in git, and since the creation of schema-reference.md is automated, (via
make docs-generate
) I don't see a reason to control the generated schema-reference.md file in git too. I'd prefer to just run themake docs-generate
every time we run the "Deploy Website" workflow. This then would mean that we could depreciate the "JSON Schema Markdown website update" workflow.Why is this my preference? @abetones' git workflow looks like this:
But with the auto-commit to website/src/pages/docs/schema-reference.md, he’s having troubles in step 6) because he has merge conflicts. He could just wait a couple of minutes (for the github pipeline to finish its update), then do a git fetch and git sync after each commit. However, it feels to me like this shouldn't be needed... So, at the risk of circular reasoning, I'd prefer to just remove the git commit and push that's done automatically by the github pipeline in the "JSON Schema Markdown website update" workflow.
The text was updated successfully, but these errors were encountered: