diff --git a/doc/img/screenshots/api_update_pr_github.png b/doc/img/screenshots/api_update_pr_github.png new file mode 100644 index 00000000..441d9847 Binary files /dev/null and b/doc/img/screenshots/api_update_pr_github.png differ diff --git a/doc/maintainers/github.md b/doc/maintainers/github.md index cf40e318..0055137a 100644 --- a/doc/maintainers/github.md +++ b/doc/maintainers/github.md @@ -24,7 +24,7 @@ setting](https://github.com/SPARC-X/SPARC-X-API/settings/pages) and set the "Source" to "Deploy from a branch", as well as "Branch" to "gh_pages", as shown in the UI screenshot below: -![Github Pages Settings](img/screenshots/github_pages_setting.png) +![Github Pages Settings](../img/screenshots/github_pages_setting.png) ### Secrets @@ -54,7 +54,7 @@ files) for debug purposes, from the "Run workflow" drop panel in the page](https://github.com/SPARC-X/SPARC-X-API/actions/workflows), as shown in the screenshot below: -![Github Actions Manual Dispatch](img/screenshots/github_action_dispatch.png) +![Github Actions Manual Dispatch](../img/screenshots/github_action_dispatch.png) - [Unit-test workflow](https://github.com/SPARC-X/SPARC-X-API/blob/master/.github/workflows/unit_test.yml) @@ -79,10 +79,17 @@ shown in the screenshot below: - [Update JSON schema workflow](https://github.com/SPARC-X/SPARC-X-API/blob/master/.github/workflows/update_api.yml) updates the JSON schema file after a new release in SPARC C/C++ - source code. + source code. The workflow is run both nightly and after normal + push. You can change the behavior as needed. - The workflow is run both nightly and after normal push. Change the - behavior as needed. + An example pull request created by the update workflow can be seen + in the following screenshot: + + ```{figure} ../img/screenshots/api_update_pr_github.png + :alt: PR on github + ``` + + Once the - [Publish PyPI workflow](https://github.com/SPARC-X/SPARC-X-API/blob/master/.github/workflows/publish-pypi.yml) diff --git a/doc/maintainers/sparc-x-api.md b/doc/maintainers/sparc-x-api.md index d3e059ed..0f12b575 100644 --- a/doc/maintainers/sparc-x-api.md +++ b/doc/maintainers/sparc-x-api.md @@ -33,4 +33,4 @@ workflow. Instead, it uses the [OIDC protocol](https://docs.pypi.org/trusted-publishers/) for a trusted publisher. The current settings on PyPI are like follows: -![pypi-setting](img/screenshots/pypi_publisher_setup.png) +![pypi-setting](../img/screenshots/pypi_publisher_setup.png)