https://github.com/code-hex/gqldoc-actions

https://github.com/code-hex/gqldoc-actions

Last synced: 7 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/code-hex/gqldoc-actions
• Owner: Code-Hex
• License: mit
• Created: 2021-03-29T06:25:39.000Z (over 4 years ago)
• Default Branch: main
• Last Pushed: 2022-11-22T07:45:31.000Z (about 3 years ago)
• Last Synced: 2025-05-06T18:09:01.235Z (7 months ago)
• Language: JavaScript
• Size: 104 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# gqldoc actions

An action for generating graphql documents used by [gqldoc](https://github.com/Code-Hex/gqldoc).

## Usage

See [action.yml](action.yml)

### Example Workflow file

```yaml

name: Generate Document and Commit

on:

  push:

    branches:

      - main

  pull_request:

jobs:

  update-docs:

    name: Update Documents

    runs-on: ubuntu-latest

    steps:

      - name: Check out code

        uses: actions/checkout@v2

        with:

          persist-credentials: false # otherwise, the token used is the GITHUB_TOKEN, instead of your personal token

          fetch-depth: 0 # otherwise, you will failed to push refs to dest repo

      - name: Push Generated GraphQL Document Current Branch

        uses: Code-Hex/gqldoc-actions@v1.0.9

        with:

          github-token: ${{ secrets.GITHUB_TOKEN }}

          schema: schema.graphql

          output: doc_dir

```

# License

The scripts and documentation in this project are released under the [MIT License](LICENSE)