Skip to content

Build secrets moved from pro-plugin to faas-cli#423

Merged
alexellis merged 1 commit intoopenfaas:masterfrom
welteki:update-build-secrets-docs
Apr 2, 2026
Merged

Build secrets moved from pro-plugin to faas-cli#423
alexellis merged 1 commit intoopenfaas:masterfrom
welteki:update-build-secrets-docs

Conversation

@welteki
Copy link
Copy Markdown
Member

@welteki welteki commented Apr 2, 2026

Description

Update build secrets documentation to reflect that build_secrets support has been moved from the pro-plugin to core faas-cli (see openfaas/faas-cli#1021).

Motivation and Context

Build secrets for local Docker builds are now handled by faas-cli build and faas-cli publish directly. The pro-plugin is no longer required. The remote builder also now requires file paths instead of literal values for build_secrets.

  • I have raised an issue to propose this change (required)

How Has This Been Tested?

Reviewed documentation changes for accuracy against the faas-cli PR.

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • I've read the CONTRIBUTION guide
  • I have signed-off my commits with git commit -s

- Remove pro-plugin references from build secrets docs, use faas-cli
  build/publish directly
- Update remote builder docs: build_secrets values are now file paths,
  not literal values
- Add build_secrets section to YAML reference

Signed-off-by: Han Verstraete (OpenFaaS Ltd) <han@openfaas.com>
@reviewfn
Copy link
Copy Markdown

reviewfn bot commented Apr 2, 2026

AI Pull Request Overview

Summary

  • Updated documentation to reflect build_secrets moved from pro-plugin to core faas-cli
  • Removed pro-plugin installation and enablement steps from build.md
  • Changed commands from faas-cli pro build to faas-cli build
  • Updated examples to use file paths instead of literal values for build_secrets
  • Added new build_secrets section in yaml.md reference
  • Added warning in builder.md about storing secrets outside handler folders

Approval rating (1-10)

8/10 - Accurate documentation updates, but lacks verification of faas-cli implementation details.

Summary per file

Summary per file
File path Summary
docs/cli/build.md Updated build secrets section to use core faas-cli, removed pro plugin requirements
docs/languages/php.md Changed reference from pro build to build secrets page
docs/openfaas-pro/builder.md Specified file paths required for build_secrets, added security warning
docs/reference/yaml.md Added build_secrets configuration section with examples

Do not include node_modules or vendor directories.

Overall Assessment

The pull request successfully updates the documentation to align with the migration of build_secrets functionality from the OpenFaaS Pro plugin to core faas-cli. Changes are consistent across files and accurately reflect the new requirements for file paths instead of literal values. However, the documentation assumes correct implementation in faas-cli without providing migration guidance for existing users who may have literal values in their configurations.

Detailed Review

Detailed Review

docs/cli/build.md

  • Removal of experimental warning is appropriate since the feature is now stable in core.
  • Updated instructions from pro plugin to direct faas-cli usage is correct.
  • Examples now properly reference file paths instead of literal values, preventing secret leakage.
  • GitHub Actions example removal is appropriate as pro plugin is no longer needed.

docs/languages/php.md

  • Reference update to build secrets page is consistent with other changes.
  • Link should be verified to ensure it resolves correctly.

docs/openfaas-pro/builder.md

  • Clarification that values must be file paths is critical for remote builder usage.
  • Added warning about secret storage location is a good security practice, but could be emphasized more strongly.
  • Example changes from literal values to file paths are accurate.

docs/reference/yaml.md

  • New build_secrets section provides necessary reference documentation.
  • Examples use environment variables for file paths, which is a good practice.
  • Link to build secrets page should be tested for accuracy.

Risk: Existing users with literal build_secrets values in stack.yaml will encounter failures after updating faas-cli, but migration path is not documented.

./REVIEW.md

AI agent details.

Agent processing time: 28.477s
Environment preparation time: 4.098s
Total time from webhook: 36.49s

@alexellis alexellis merged commit de3b5bc into openfaas:master Apr 2, 2026
5 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants