# Config Sync Action

The SAML.to Config Sync action is an alternative and/or supplement to the webhook that is installed on the `saml-to` repository.

Upon invocation, it will request the SAML.to backend to refresh any changes made to the `saml-to.yml` configuration file.

```
steps:
  - uses: saml-to/config-sync-action@v1
    env:
      GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```

This will inform the SAML.to backend to refresh the `saml-to.yml` file on the **default branch** of the repository.

### Checking saml-to.yml for errors

The `saml-to.yml` file can be edited directly or using Pull Requests (PRs), but if you would like to check the `saml-to.yml` for errors during a PR, it has a `dryrun` mode so checks for correctness can be made:

```
name: Validate
on:
  workflow_dispatch:
  push:
    branches:
      - "*"
  pull_request:
    branches:
      - main
      
jobs:
  validate-saml-to:
    runs-on: ubuntu-latest
    steps:
      - uses: saml-to/config-sync-action@v1
        with:
          dryrun: true
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
```


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.saml.to/usage/github-actions/config-sync-action.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.