Skip to content

Latest commit

 

History

History
79 lines (59 loc) · 3.44 KB

File metadata and controls

79 lines (59 loc) · 3.44 KB

CocoaPods Azure Universal Packages plugin

This project is a CocoaPods plugin that allows to dowload pods published as Universal Packages in Azure Artifacts feeds.

Getting started

Install the plugin by adding to your Gemfile

gem "cocoapods-azure-universal-packages"

Under the hood the plugin uses the Azure CLI to download the Universal Packages, you can install it running

brew update && brew install azure-cli

Finally, ensure that you are logged in using

az login

How it works

The plugin replaces the default CocoaPods HTTP downloader when a pod source URL points to a universal package and it uses the Azure CLI to perform the download.

Note: The plugin will install the Azure CLI DevOps extension automatically when running pod install or pod update for the first time.

Usage

Add to your Podfile

plugin 'cocoapods-azure-universal-packages', {
    :organization => '{{ORGANIZATION_URL}}'
}

replacing {{ORGANIZATION_URL}} with the base URL of your Azure Artifacts feed (for example: https://pkgs.dev.azure.com/myorg).

Then, in your podspec set the pod's source to

# For project scoped feeds:
spec.source = { :http => '{{ORGANIZATION_URL}}/{{PROJECT}}/_apis/packaging/feeds/{{FEED}}/upack/packages/{{PACKAGE}}/versions/{{VERSION}}' }

# For organization scoped feeds:
spec.source = { :http => '{{ORGANIZATION_URL}}/_apis/packaging/feeds/{{FEED}}/upack/packages/{{PACKAGE}}/versions/{{VERSION}}' }

where:

  • {{ORGANIZATION_URL}} is the URL of your feed's organization
  • {{PROJECT}} is the name of your feed's project (you must specify this only if your feed is a project scoped feed)
  • {{PACKAGE}} is the name of your universal package
  • {{VERSION}} is the version of your universal package

Plugin parameters

Parameter Description
organization The URL of the Azure Artifacts feed's orgnization. Required unless organizations is specified.
organizations An array of URLs of possible Azure Artifacts feeds' organizations. Required unless organization is specified.
update_cli_extension Whether to update the Azure CLI DevOps extensions automatically. Default to false.

Run tests for this plugin

To run the tests, use

rake tests

Contributing

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.

When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact [email protected] with any additional questions or comments.