docs: rewrites admin docs to 3.0 #1842
Workflow file for this run
This file contains 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
name: pr-title | |
on: | |
pull_request: | |
types: | |
- opened | |
- edited | |
- synchronize | |
permissions: | |
pull-requests: write | |
jobs: | |
main: | |
name: lint-pr-title | |
runs-on: ubuntu-latest | |
steps: | |
- uses: amannn/action-semantic-pull-request@v5 | |
id: lint_pr_title | |
env: | |
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} | |
with: | |
types: | | |
build | |
chore | |
ci | |
docs | |
feat | |
fix | |
perf | |
refactor | |
revert | |
style | |
test | |
types | |
scopes: | | |
cpa | |
db-\* | |
db-mongodb | |
db-postgres | |
email-nodemailer | |
eslint | |
graphql | |
live-preview | |
live-preview-react | |
next | |
payload | |
plugin-cloud | |
plugin-cloud-storage | |
plugin-form-builder | |
plugin-nested-docs | |
plugin-redirects | |
plugin-relationship-object-ids | |
plugin-search | |
plugin-sentry | |
plugin-seo | |
plugin-stripe | |
richtext-\* | |
richtext-lexical | |
richtext-slate | |
storage-\* | |
storage-azure | |
storage-gcs | |
storage-vercel-blob | |
storage-s3 | |
translations | |
ui | |
templates | |
examples(\/(\w|-)+)? | |
deps | |
# Disallow uppercase letters at the beginning of the subject | |
subjectPattern: ^(?![A-Z]).+$ | |
subjectPatternError: | | |
The subject "{subject}" found in the pull request title "{title}" | |
didn't match the configured pattern. Please ensure that the subject | |
doesn't start with an uppercase character. | |
- uses: marocchino/sticky-pull-request-comment@v2 | |
# When the previous steps fails, the workflow would stop. By adding this | |
# condition you can continue the execution with the populated error message. | |
if: always() && (steps.lint_pr_title.outputs.error_message != null) | |
with: | |
header: pr-title-lint-error | |
message: | | |
Pull Request titles must follow the [Conventional Commits specification](https://www.conventionalcommits.org/en/v1.0.0/) and have valid scopes. | |
${{ steps.lint_pr_title.outputs.error_message }} | |
``` | |
feat(ui): add Button component | |
^ ^ ^ | |
| | |__ Subject | |
| |_______ Scope | |
|____________ Type | |
``` | |
# Delete a previous comment when the issue has been resolved | |
- if: ${{ steps.lint_pr_title.outputs.error_message == null }} | |
uses: marocchino/sticky-pull-request-comment@v2 | |
with: | |
header: pr-title-lint-error | |
delete: true |