diff --git a/.github/workflows/docs-elastic-co-publish.yml b/.github/workflows/docs-elastic-co-publish.yml index d7a39c7..72f4ac2 100644 --- a/.github/workflows/docs-elastic-co-publish.yml +++ b/.github/workflows/docs-elastic-co-publish.yml @@ -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: '' diff --git a/README.md b/README.md index 87f99bc..8f4871e 100644 --- a/README.md +++ b/README.md @@ -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