Skip to content

docs(ios): document plugin variables in Swift package manifests, needs cordova-ios 8.2.0 - #1529

Open
GitToTheHub wants to merge 4 commits into
apache:masterfrom
GitToTheHub:docs/ios-swift-package-variables
Open

GitToTheHub wants to merge 4 commits into
apache:masterfrom
GitToTheHub:docs/ios-swift-package-variables

Conversation

@GitToTheHub

@GitToTheHub GitToTheHub commented Sep 23, 2026 •

Copy link
Copy Markdown
Contributor

Platforms affected

iOS

Motivation and Context

apache/cordova-ios#1724 adds plugin variable substitution in Package.swift. Plugin authors need an example showing how CLI values and defaults from plugin.xml control Swift package dependencies.

Related to #1520, which added the package.json reference documenting saved plugin variables.

This can be merged, after cordova-ios 8.2.0 was released.

Generated-By: GPT-6

Description

  • Add an SDK version example to the iOS plugin guide covering preference defaults, CLI overrides, and storage in cordova.plugins.
  • Explain that substitution affects the copied manifest and does not apply to --link installations.
  • Cross-link the iOS guide, plugin preference reference, and package.json reference.
  • Document availability starting with cordova-ios 8.2.0.
  • Explain that version placeholders can prevent a plugin from working as a standalone Swift package, including running its own tests.

Testing

  • git diff --check passed.
  • npm run build completed reference fetching, TOC/data generation, and styles, but failed at Jekyll because the local Ruby environment could not find Bundler 4.0.16.

Checklist

  • I've run the tests to see all new and existing tests pass
  • I added automated test coverage as appropriate for this change (documentation only; no new tests needed)
  • Commit is prefixed with (platform) if this change only applies to one platform (e.g. (android))
  • If this Pull Request resolves an issue, I linked to the issue in the text above (no issue closed; related PRs linked)
  • I've updated the documentation if necessary

@GitToTheHub
GitToTheHub force-pushed the docs/ios-swift-package-variables branch from ab24e51 to 3ea689f Compare September 23, 2026 12:50
@GitToTheHub
GitToTheHub marked this pull request as draft September 23, 2026 12:52
@GitToTheHub
GitToTheHub marked this pull request as ready for review September 23, 2026 13:29
@GitToTheHub GitToTheHub changed the title docs(ios): document plugin variables in Swift package manifests docs(ios): document plugin variables in Swift package manifests, needs cordova-ios 8.2.0 Sep 26, 2026
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.

1 participant