Skip to content

Commit

Permalink
Merging to release-4-lts: Send an event to the tyk docs repo on confi…
Browse files Browse the repository at this point in the history
…g update (#4881)

Send an event to the tyk docs repo on config update (#4881)

<!-- Provide a general summary of your changes in the Title above -->

## Description
- Whenever the config.go is updated an event will be sent to the tyk
docs repo and this will generate the docs. Previously this was done
manually but this pull request will automate it.
Issue : https://tyktech.atlassian.net/browse/TT-8253
<!-- Describe your changes in detail -->

## Related Issue
https://tyktech.atlassian.net/browse/TT-8253
<!-- This project only accepts pull requests related to open issues. -->
<!-- If suggesting a new feature or change, please discuss it in an
issue first. -->
<!-- If fixing a bug, there should be an issue describing it with steps
to reproduce. -->
<!-- OSS: Please link to the issue here. Tyk: please create/link the
JIRA ticket. -->

## Motivation and Context

<!-- Why is this change required? What problem does it solve? -->

## How This Has Been Tested

<!-- Please describe in detail how you tested your changes -->
<!-- Include details of your testing environment, and the tests -->
<!-- you ran to see how your change affects other areas of the code,
etc. -->
<!-- This information is helpful for reviewers and QA. -->

## Screenshots (if appropriate)

## Types of changes

<!-- What types of changes does your code introduce? Put an `x` in all
the boxes that apply: -->

- [ ] Bug fix (non-breaking change which fixes an issue)
- [X] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing
functionality to change)
- [ ] Refactoring or add test (improvements in base code or adds test
coverage to functionality)

## Checklist

<!-- Go over all the following points, and put an `x` in all the boxes
that apply -->
<!-- If there are no documentation updates required, mark the item as
checked. -->
<!-- Raise up any additional concerns not covered by the checklist. -->

- [X ] I ensured that the documentation is up to date
- [ ] I explained why this PR updates go.mod in detail with reasoning
why it's required
- [ ] I would like a code coverage CI quality gate exception and have
explained why
  • Loading branch information
buger committed May 11, 2023
1 parent d9dde8f commit 3f64ac6
Showing 1 changed file with 23 additions and 0 deletions.
23 changes: 23 additions & 0 deletions .github/workflows/update-config-docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Keep the docs on tyk-docs in sync with this branch's docs

name: Update Config docs

on:
push:
branches:
- master
- release-**
paths:
- config/config.go

jobs:
sync:
name: tyk-config-docs
runs-on: ubuntu-latest
steps:
- uses: peter-evans/repository-dispatch@v1
with:
token: ${{ secrets.ORG_GH_TOKEN }}
repository: TykTechnologies/tyk-docs
event-type: tyk-config-docs
client-payload: '{"ref": "${{ github.ref }}", "sha": "${{ github.sha }}","repo":"gateway","branch":"${{github.ref_name}}"}'

0 comments on commit 3f64ac6

Please sign in to comment.