Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: Test the check file name step #791

Draft
wants to merge 9 commits into
base: master
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,13 @@ name: Check Antora content guidelines in Pull Request

on:
workflow_call: # this allows the workflow to be reused
inputs:
# Available steps: https://github.com/bonitasoft/actions/blob/main/packages/doc-contribs/pr-antora-content-guidelines-checker/README.md#using-this-action
steps-to-skip:
type: string
description: 'Comma-separated list of steps to skip, by default all steps are executed.'
default: ''
required: false

jobs:
checks:
Expand All @@ -20,3 +27,4 @@ jobs:
files-to-check: 'adoc'
# WARN: Be aware that spaces after/before the coma are not trimmed by the action. This means that the spaces are part of the pattern.
forbidden-pattern-to-check: 'https://documentation.bonitasoft.com,link:https,link:http,link:,xref:https,xref:http,xref:_,xref:#,Bonita BPM,https://api-documentation.bonitasoft.com'
steps-to-skip: ${{ inputs.steps-to-skip }}
5 changes: 3 additions & 2 deletions .github/workflows/pr-antora-checker-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@ name: Contribution checks on test data

on:
# use pull_request event to test update done of the reusable workflow (update the branch of the reusable workflow as well in this case)
pull_request_target:
# TODO: restore pull_request_target before merging this PR
pull_request:
paths:
- '.github/workflows/_reusable_pr-antora-content-guidelines-checker.yml'
- '.github/workflows/pr-antora-checker-test.yml'
Expand All @@ -12,4 +13,4 @@ jobs:
check_antora_content_guidelines:
permissions:
pull-requests: write # "pr-antora-content-guidelines-checker" write PR comments when the PR doesn't match the "Guidelines"
uses: bonitasoft/bonita-documentation-site/.github/workflows/_reusable_pr-antora-content-guidelines-checker.yml@master
uses: bonitasoft/bonita-documentation-site/.github/workflows/_reusable_pr-antora-content-guidelines-checker.yml
2 changes: 1 addition & 1 deletion .github/workflows/pr-comment-list-changes.yml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
name: Comments PR with changes list

on:
pull_request_target:
pull_request:
paths:
- '.github/workflows/_reusable_pr-comment-list-changes.yml'
- '.github/workflows/pr-comment-list-changes.yml'
Expand Down
Original file line number Diff line number Diff line change
@@ -1 +1 @@
** xref:index.adoc[module-01]
** xref:toto.adoc[module-01]
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
** xref:index.adoc[module-01]
** xref:TestOfBadFileName.adoc[TestOfBadFileName]
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
= Test of bad file name
:description: Test bad file name description

xref:ROOT:old-page-01.adoc[link to ROOT old page 01].

xref:ROOT:page-01.adoc[link to ROOT page 01].


xref:bonita:module-02:old-page01.adoc[link to module-02 old page 01].

xref:bonita:module-02:page01.adoc[link to module-02 page 01].

Loading