Skip to content

Document the subdirectory input #44

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

Closed
wants to merge 2 commits into from
Closed
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
11 changes: 11 additions & 0 deletions .github/workflows/docs-elastic-co-publish.yml
Original file line number Diff line number Diff line change
@@ -9,6 +9,17 @@ on:
type: string
repo:
type: string
#
# Pass a `subdirectory` to this workflow from a content repo if you
# only want to grab files from a specific subdirectory in the
# content repo. If you do not specify a `subdirectoy`, the workflow
# will grab all relevant files from the entire repo.
#
# IMPORTANT: Always include a trailing slash when defining a
# subdirectory. For example:
# with:
# subdirectory: 'docs/en/serverless/'
#
subdirectory:
type: string
default: ''
9 changes: 9 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -87,6 +87,15 @@ jobs:

Change values as needed.

You can optionally pass a `subdirectory` to this workflow from a content repo if you only want to grab files from a specific subdirectory in the content repo. If you do not specify a `subdirectoy`, the workflow will grab all relevant files from the entire repo.

>[!IMPORTANT]
>Always include a trailing slash when defining a `subdirectory`. For example:
>```
> with:
> subdirectory: 'docs/en/serverless/'
>```

Install as `.github/workflows/co-docs-builder.yml` in content source.

#### Private repos