Skip to content

Commit

Permalink
update link
Browse files Browse the repository at this point in the history
  • Loading branch information
alchem0x2A committed Nov 28, 2024
1 parent 5c87ff3 commit 19090d6
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 6 deletions.
Binary file added doc/img/screenshots/api_update_pr_github.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
17 changes: 12 additions & 5 deletions doc/maintainers/github.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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)
Expand All @@ -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)
Expand Down
2 changes: 1 addition & 1 deletion doc/maintainers/sparc-x-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -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)

0 comments on commit 19090d6

Please sign in to comment.