Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/josephduffy/update-xcode-version-action
GitHub Action to automate Xcode updates
https://github.com/josephduffy/update-xcode-version-action
github-actions swift xcode
Last synced: 23 days ago
JSON representation
GitHub Action to automate Xcode updates
- Host: GitHub
- URL: https://github.com/josephduffy/update-xcode-version-action
- Owner: JosephDuffy
- Created: 2020-06-05T15:41:13.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-07T00:20:31.000Z (almost 2 years ago)
- Last Synced: 2024-09-17T21:49:02.267Z (about 2 months ago)
- Topics: github-actions, swift, xcode
- Language: TypeScript
- Homepage:
- Size: 2.23 MB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# update-xcode-version-action
[](https://codecov.io/gh/JosephDuffy/update-xcode-version-action)
`update-xcode-version-action` is a GitHub Action that utilises [`xcutils`](https://github.com/JosephDuffy/xcutils) to automate the creation of pull requests when a new Xcode version is available (on GitHub Actions).
It can be configured to update GitHub Actions workflow files and create a pull request with the changes.
Thanks to `xcutils` [versions can be specified as `latest`, `beta`, `last-minor`, etc.](https://github.com/JosephDuffy/xcutils#version-specifiers), allowing for a single configuration to continue working without the need for extra tweaking. **You can think of your versions specification as a lock file for Xcode versions**.
## Configuration
Xcode versions are configured using a yaml file. By default the action will look for a file at `.github/xcode-versions.yml`, but you can configure it to look elsewhere.
For example to have a release workflow use the latest Xcode and tests to use the next available beta and the last minor version you can create a yaml file such as:
```yaml
workflows:
workflows/test.yml:
jobs:
run_tests:
strategy:
matrix:
xcode:
- last-minor
- latest
- beta
workflows/release.yml:
jobs:
release:
strategy:
matrix:
xcode:
- latest
```
This would update a workflow file with the following structure:
```yaml
name: Tests
on: [push]
jobs:
run_tests:
name: Run Tests
runs-on: macos-latest
strategy:
fail-fast: false
matrix:
xcode: ["11.1", "11.2.1", "11.3-beta"]
steps:
- uses: actions/checkout@v2
- name: Select Xcode ${{ matrix.xcode }}
run: sudo xcode-select --switch /Applications/Xcode_${{ matrix.xcode }}.app
run: xcodebuild ... # Run your tests
```
Running a check for updates can be done automatically or manually by adding a new workflow to the project that runs the `update-xcode-version-action` action, e.g.:
```yaml
name: "Check for Xcode Updates"
on:
# Allow to be run manually
workflow_dispatch:
# Run at 8am UTC daily
schedule:
- cron: "0 8 * * *"
jobs:
update-xcode-versions:
name: Check for Xcode Updates
runs-on: macOS-latest
steps:
- uses: actions/checkout@v2
with:
token: ${{ secrets.UPDATE_XCODE_VERSIONS_GITHUB_TOKEN }} # A token that can update workflows, required to push changes to workflow files
- name: Update Xcode Versions
uses: josephduffy/update-xcode-version-action@master
with:
github-token: ${{ secrets.GITHUB_TOKEN }} # Required to create pull requests, can be the default token provided by GitHub Actions
xcode-versions-file: .github/xcode-versions.yml # Default, not required, but can be changed
```
When `update-xcode-version-action` discovers a change in the resolved versions it will create a pull request with the changes.
## Badge Generation
`update-xcode-version-action` can be configured to create a badge that displays the supported Xcode versions, which fits in well for use in READMEs.
```yaml
# ...
- name: Update Xcode Versions
uses: josephduffy/update-xcode-version-action@master
with:
xcode-version-badge-path: ./.github/xcode-versions-badge.svg # Provide a path to output the badge to
xcode-version-badge-versions: "last-major, latest, beta" # A comma separated list of versions to display in the badge. Defaults to "latest".
# ...
```
This would produce: [](https://github.com/JosephDuffy/update-xcode-version-action/blob/update-xcode-version-action/update-xcode-versions/.github/xcode-versions-badge.svg)