semantic-release-cocoapods
v2.0.0
Published
Cocoapods publishing plugin for semantic-release
Maintainers
Readme
semantic-release-cocoapods
semantic-release plugin to publish a cocoapods package.
| Step | Description |
|--------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| verifyConditions | Verify pod command exists, COCOAPODS_TRUNK_TOKEN environment variable is set, pod trunk me is successful. Run pod lib lint to verify the pod is ready to publish. |
| prepare | Update the podspec version. |
| publish | Publish the cocoapods pod to the registry. |
Install
$ npm install semantic-release-cocoapods -DUsage
First, make sure that cocoapods is installed on your machine.
Next, add the plugin to your semantic-release configuration file.
{
"plugins": [
"@semantic-release/commit-analyzer",
"@semantic-release/release-notes-generator",
"semantic-release-cocoapods"
]
}Configuration
Environment variables
To use this plugin and ultimately publish a cocoapods package, you must set these environment variables.
| Variable | Description |
|-------------------------|------------------------------------------------------------------------------------------------------------------|
| COCOAPODS_TRUNK_TOKEN | Created token to push pod to cocoapods.org. |
Options
| Options | Description | Default |
|---------------|---------------------------------------------|-----------|
| podLint | Whether to lint the pod or not. | true |
| podLintArgs | Extra arguments to pass to pod lib lint | |
| podPushArgs | Extra arguments to pass to pod trunk push | |
Examples
Here is an example on how to set options
{
"plugins": [
"@semantic-release/github",
["semantic-release-cocoapods", {
"podLint": false,
"podLintArgs": "--allow-warnings",
}]
]
}