GH Actions: auto-trigger update of schema website #1097
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Adds a workflow job to send out a GH API request whenever a new release is tagged. The API request will trigger a workflow in the https://github.com/PHPCSStandards/schema.phpcodesniffer.com repository, which will update the schema.phpcodesniffer.com website. As this is a cross-repo request, the standard GH secret is not sufficient. A Personal Access Token has been created on the PHPCSStandards organisation to facilitate workflow dispatches. This PAT has been added to the repo actions secrets, so it can be safely used in this workflow. The PAT token is a fine-grained one and needs the following permissions for this dispatch to succeed: - contents: read & write - metadata: read only (automatically selected when selecting the contents permission) Note: The Personal Access Token needs to be renewed once a year. Fixes 1094 (together with the newly set up https://github.com/PHPCSStandards/schema.phpcodesniffer.com repo
jrfnl
deleted the
feature/1094-ghactions-trigger-publish-xsd-files-via-stable-url
branch
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Adds a workflow job to send out a GH API request whenever a new release is tagged. The API request will trigger a workflow in the https://github.com/PHPCSStandards/schema.phpcodesniffer.com repository, which will update the schema.phpcodesniffer.com website.
As this is a cross-repo request, the standard GH secret is not sufficient. A Personal Access Token has been created on the PHPCSStandards organisation to facilitate workflow dispatches. This PAT has been added to the repo actions secrets, so it can be safely used in this workflow.
The PAT token is a fine-grained one and needs the following permissions for this dispatch to succeed:
Note: The Personal Access Token needs to be renewed once a year.
Suggested changelog entry
Other:
The latest PHP_CodeSniffer XSD file is now available via the following permalink: schema.phpcodesniffer.com/phpcs.xsd
Older XSD files can be referenced via permalinks based on their minor: schema.phpcodesniffer.com/#.#/phpcs.xsd
Related issues/external references
Fixes #1094 (together with the newly set up https://github.com/PHPCSStandards/schema.phpcodesniffer.com repo