Skip to content

update lua walk function doc #489

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.

Sign up for GitHub

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

Merged
michaeljguarino merged 1 commit into from
Jul 15, 2025
Merged

update lua walk function doc #489

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 15 additions & 15 deletions generated/routes.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@
},
"/overview/management-api-reference": {
"relPath": "/overview/management-api-reference.md",
"lastmod": "2025-07-09T01:30:04.000Z"
"lastmod": "2025-07-15T06:47:44.000Z"
},
"/overview/agent-api-reference": {
"relPath": "/overview/agent-api-reference.md",
Expand All @@ -25,19 +25,19 @@
},
"/getting-started/first-steps": {
"relPath": "/getting-started/first-steps/index.md",
"lastmod": "2025-07-14T14:28:27.000Z"
"lastmod": "2025-07-14T14:40:01.000Z"
},
"/getting-started/first-steps/cli-quickstart": {
"relPath": "/getting-started/first-steps/cli-quickstart.md",
"lastmod": "2025-07-14T14:28:27.000Z"
"lastmod": "2025-07-14T14:40:01.000Z"
},
"/getting-started/first-steps/existing-cluster": {
"relPath": "/getting-started/first-steps/existing-cluster.md",
"lastmod": "2025-03-27T19:09:28.000Z"
},
"/getting-started/first-steps/plural-cloud": {
"relPath": "/getting-started/first-steps/plural-cloud.md",
"lastmod": "2025-07-14T14:28:27.000Z"
"lastmod": "2025-07-14T15:36:50.000Z"
},
"/getting-started/how-to-use": {
"relPath": "/getting-started/how-to-use/index.md",
Expand All @@ -53,23 +53,23 @@
},
"/getting-started/how-to-use/scm-connection": {
"relPath": "/getting-started/how-to-use/scm-connection.md",
"lastmod": "2025-07-14T14:28:27.000Z"
"lastmod": "2025-07-14T14:40:01.000Z"
},
"/getting-started/how-to-use/workload-cluster": {
"relPath": "/getting-started/how-to-use/workload-cluster.md",
"lastmod": "2025-03-12T14:59:41.000Z"
},
"/getting-started/how-to-use/controllers": {
"relPath": "/getting-started/how-to-use/controllers.md",
"lastmod": "2025-07-14T14:28:27.000Z"
"lastmod": "2025-07-14T14:40:01.000Z"
},
"/getting-started/how-to-use/observability": {
"relPath": "/getting-started/how-to-use/observability.md",
"lastmod": "2025-07-14T14:28:27.000Z"
"lastmod": "2025-07-14T14:40:01.000Z"
},
"/getting-started/how-to-use/microservice": {
"relPath": "/getting-started/how-to-use/microservice.md",
"lastmod": "2025-07-14T14:28:27.000Z"
"lastmod": "2025-07-14T14:40:01.000Z"
},
"/getting-started/how-to-use/pr-automation": {
"relPath": "/getting-started/how-to-use/pr-automation.md",
Expand All @@ -81,7 +81,7 @@
},
"/getting-started/how-to-use/cleaning-up": {
"relPath": "/getting-started/how-to-use/cleaning-up.md",
"lastmod": "2025-07-14T14:28:27.000Z"
"lastmod": "2025-07-14T14:40:01.000Z"
},
"/getting-started/advanced-config": {
"relPath": "/getting-started/advanced-config/index.md",
Expand Down Expand Up @@ -377,7 +377,7 @@
},
"/getting-started/quickstart": {
"relPath": "/getting-started/first-steps/index.md",
"lastmod": "2025-07-14T14:28:27.000Z"
"lastmod": "2025-07-14T14:40:01.000Z"
},
"/deployments/architecture": {
"relPath": "/overview/architecture.md",
Expand All @@ -393,15 +393,15 @@
},
"/deployments/cli-quickstart": {
"relPath": "/getting-started/first-steps/cli-quickstart.md",
"lastmod": "2025-07-14T14:28:27.000Z"
"lastmod": "2025-07-14T14:40:01.000Z"
},
"/deployments/existing-cluster": {
"relPath": "/getting-started/first-steps/existing-cluster.md",
"lastmod": "2025-03-27T19:09:28.000Z"
},
"/getting-started/deployments": {
"relPath": "/getting-started/first-steps/index.md",
"lastmod": "2025-07-14T14:28:27.000Z"
"lastmod": "2025-07-14T14:40:01.000Z"
},
"/how-to/set-up/mgmt-cluster": {
"relPath": "/getting-started/how-to-use/mgmt-cluster.md",
Expand All @@ -413,23 +413,23 @@
},
"/how-to/set-up/scm-connection": {
"relPath": "/getting-started/how-to-use/scm-connection.md",
"lastmod": "2025-07-14T14:28:27.000Z"
"lastmod": "2025-07-14T14:40:01.000Z"
},
"/how-to/set-up/workload-cluster": {
"relPath": "/getting-started/how-to-use/workload-cluster.md",
"lastmod": "2025-03-12T14:59:41.000Z"
},
"/how-to/set-up/controllers": {
"relPath": "/getting-started/how-to-use/controllers.md",
"lastmod": "2025-07-14T14:28:27.000Z"
"lastmod": "2025-07-14T14:40:01.000Z"
},
"/how-to/deploy/pr-automation": {
"relPath": "/getting-started/how-to-use/pr-automation.md",
"lastmod": "2025-03-12T14:59:41.000Z"
},
"/how-to/deploy/microservice": {
"relPath": "/getting-started/how-to-use/microservice.md",
"lastmod": "2025-07-14T14:28:27.000Z"
"lastmod": "2025-07-14T14:40:01.000Z"
},
"/how-to/deploy/pipelines": {
"relPath": "/getting-started/how-to-use/pipelines.md",
Expand Down
24 changes: 21 additions & 3 deletions pages/plural-features/continuous-deployment/lua.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,14 +127,32 @@ end
Returns a list of all files within the specified directory and its subdirectories.

```lua
local files = fs.walk(".")
if files then
values["allFiles"] = files
-- Example 1: Walk directory without ignoring dotfiles
local files, err = fs.walk("mydir")
if not files then
print("Error:", err)
else
for _, file in ipairs(files) do
print(file)
end
end

-- Example 2: Walk directory while ignoring dotfiles
local files, err = fs.walk("mydir", true)
if not files then
print("Error:", err)
else
for _, file in ipairs(files) do
print(file)
end
end

```

**Parameters:**
- `directory` (string): Relative path to the directory within the base directory
- `ignoreDotfiles` (boolean, optional): When set to `true`, the function will exclude dotfiles and directories starting with `.` from the returned list. Default value: `false`


**Returns:**
- `[string]`: Array of relative file paths, or `nil` and error message on failure
Expand Down
Loading