https://github.com/microsoft/cocoapods-azure-universal-packages
CocoaPods plugin for downloading Universal Packages from Azure Artifacts feeds.
https://github.com/microsoft/cocoapods-azure-universal-packages
azure-artifacts cocoapods cocoapods-plugin
Last synced: 9 months ago
JSON representation
CocoaPods plugin for downloading Universal Packages from Azure Artifacts feeds.
- Host: GitHub
- URL: https://github.com/microsoft/cocoapods-azure-universal-packages
- Owner: microsoft
- License: mit
- Created: 2020-09-14T11:45:59.000Z (almost 6 years ago)
- Default Branch: main
- Last Pushed: 2024-05-16T21:59:30.000Z (about 2 years ago)
- Last Synced: 2025-01-30T11:33:48.978Z (over 1 year ago)
- Topics: azure-artifacts, cocoapods, cocoapods-plugin
- Language: Ruby
- Homepage:
- Size: 25.4 KB
- Stars: 10
- Watchers: 6
- Forks: 10
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# CocoaPods Azure Universal Packages plugin
This project is a [CocoaPods](https://github.com/CocoaPods/CocoaPods) plugin that allows to dowload pods published as [Universal Packages](https://docs.microsoft.com/en-us/azure/devops/artifacts/quickstarts/universal-packages) in [Azure Artifacts](https://azure.microsoft.com/en-gb/services/devops/artifacts/) feeds.
## Getting started
Install the plugin by adding to your `Gemfile`
```Ruby
gem "cocoapods-azure-universal-packages"
```
Under the hood the plugin uses the [Azure CLI](https://aka.ms/azcli) to download the Universal Packages, you can install it running
```shell
brew update && brew install azure-cli
```
Finally, ensure that you are logged in using
```shell
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](https://github.com/Azure/azure-devops-cli-extension) automatically when running `pod install` or `pod update` for the first time.
## Usage
Add to your Podfile
```Ruby
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
```Ruby
# 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
```shell
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](https://opensource.microsoft.com/codeofconduct/).
For more information see the [Code of Conduct FAQ](https://opensource.microsoft.com/codeofconduct/faq/) or
contact [opencode@microsoft.com](mailto:opencode@microsoft.com) with any additional questions or comments.