From f79bdb754c7bf4825338a20a0e5418d8acda7efa Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pedro=20Pi=C3=B1era=20Buend=C3=ADa?= <663605+pepicrft@users.noreply.github.com> Date: Fri, 27 Sep 2024 19:05:36 +0200 Subject: [PATCH] fix: repository cleanup (#859) * Remove .sourcery.yml * Remove .xcode-version * Remove REALEASE.md * Remove deploy-docs pipeline * Remove Info.plist * Update README.md * Remove Netlify badge * Configure Swift Package Index to deploy the documentation --- .github/workflows/deploy-docs.yml | 49 ------------------------------- .sourcery.yml | 6 ---- .spi.yml | 4 +++ .xcode-version | 1 - Info.plist | 26 ---------------- README.md | 8 +---- RELEASE.md | 10 ------- 7 files changed, 5 insertions(+), 99 deletions(-) delete mode 100644 .github/workflows/deploy-docs.yml delete mode 100644 .sourcery.yml create mode 100644 .spi.yml delete mode 100644 .xcode-version delete mode 100644 Info.plist delete mode 100644 RELEASE.md diff --git a/.github/workflows/deploy-docs.yml b/.github/workflows/deploy-docs.yml deleted file mode 100644 index 82cb9d5db..000000000 --- a/.github/workflows/deploy-docs.yml +++ /dev/null @@ -1,49 +0,0 @@ -name: Deploy Docs - -on: - workflow_dispatch: {} - push: - branches: - - main - -concurrency: - group: deploy-docs-${{ github.head_ref }} - cancel-in-progress: true - -jobs: - deploy: - name: Deploy Documentation - runs-on: macos-14 - steps: - - name: Start deployment - uses: bobheadxi/deployments@v1 - id: deployment - with: - env: production - step: start - - name: Checkout Package - uses: actions/checkout@v3 - with: - fetch-depth: 0 - - name: Select Xcode - run: sudo xcode-select -switch /Applications/Xcode_$(cat .xcode-version).app - - name: Build documentation - run: swift package --allow-writing-to-directory ./docs generate-documentation --target XcodeProj --output-path ./docs --transform-for-static-hosting --hosting-base-path / --disable-indexing - - name: Publish to Cloudflare Pages - uses: cloudflare/pages-action@v1 - with: - apiToken: ${{ secrets.CLOUDFLARE_API_TOKEN }} - accountId: cc0237353f2f825680b0463629cd4a86 - projectName: xcodeproj-docs - directory: docs/ - gitHubToken: ${{ secrets.GITHUB_TOKEN }} - wranglerVersion: '3' - - name: Finish deployment - uses: bobheadxi/deployments@v1 - if: always() - with: - env: ${{ steps.deployment.outputs.env }} - step: finish - status: ${{ job.status }} - deployment_id: ${{ steps.deployment.outputs.deployment_id }} - env_url: "https://xcodeproj.tuist.io" diff --git a/.sourcery.yml b/.sourcery.yml deleted file mode 100644 index e575499c2..000000000 --- a/.sourcery.yml +++ /dev/null @@ -1,6 +0,0 @@ -sources: - - Sources/ -templates: - - templates -output: - Sources/XcodeProj/Objects/Sourcery diff --git a/.spi.yml b/.spi.yml new file mode 100644 index 000000000..c3c607785 --- /dev/null +++ b/.spi.yml @@ -0,0 +1,4 @@ +version: 1 +builder: + configs: + - documentation_targets: [XcodeProj] diff --git a/.xcode-version b/.xcode-version deleted file mode 100644 index 2bbd2b4b4..000000000 --- a/.xcode-version +++ /dev/null @@ -1 +0,0 @@ -15.0.1 diff --git a/Info.plist b/Info.plist deleted file mode 100644 index a11b3ce78..000000000 --- a/Info.plist +++ /dev/null @@ -1,26 +0,0 @@ - - - - - CFBundleDevelopmentRegion - $(DEVELOPMENT_LANGUAGE) - CFBundleExecutable - $(EXECUTABLE_NAME) - CFBundleIdentifier - $(PRODUCT_BUNDLE_IDENTIFIER) - CFBundleInfoDictionaryVersion - 6.0 - CFBundleName - $(PRODUCT_NAME) - CFBundlePackageType - FMWK - CFBundleShortVersionString - 1.0 - CFBundleVersion - $(CURRENT_PROJECT_VERSION) - NSHumanReadableCopyright - Copyright ©. All rights reserved. - NSPrincipalClass - - - diff --git a/README.md b/README.md index 2f504e865..ff763a9e6 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,5 @@ # XcodeProj -[![Netlify Status](https://api.netlify.com/api/v1/badges/005ef674-d103-4b05-a4d1-79413ce9d766/deploy-status)](https://app.netlify.com/sites/xcodeproj/deploys) - [![All Contributors](https://img.shields.io/badge/all_contributors-41-orange.svg?style=flat-square)](#contributors-) @@ -10,6 +8,7 @@ [![Release](https://img.shields.io/github/release/tuist/xcodeproj.svg)](https://github.com/tuist/xcodeproj/releases) [![Code Coverage](https://codecov.io/gh/tuist/xcodeproj/branch/main/graph/badge.svg)](https://codecov.io/gh/tuist/xcodeproj) [![License](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/tuist/xcodeproj/blob/main/LICENSE.md) +[![](https://img.shields.io/endpoint?url=https%3A%2F%2Fswiftpackageindex.com%2Fapi%2Fpackages%2Ftuist%2FXcodeProj%2Fbadge%3Ftype%3Dswift-versions)](https://swiftpackageindex.com/tuist/XcodeProj) XcodeProj is a library written in Swift for parsing and working with Xcode projects. It's heavily inspired by [CocoaPods XcodeProj](https://github.com/CocoaPods/Xcodeproj) and [xcode](https://www.npmjs.com/package/xcode). @@ -20,7 +19,6 @@ XcodeProj is a library written in Swift for parsing and working with Xcode proje - [Installation](#installation) - [Swift Package Manager](#swift-package-manager) - [Scripting](#scripting) - - [Documentation 📝](#documentation-) - [References 📚](#references-) - [Contributing](#contributing) - [License](#license) @@ -107,10 +105,6 @@ object. [`swift-sh`]: https://github.com/mxcl/swift-sh -## Documentation 📝 - -Want to start using XcodeProj? Start by digging into our [documentation](/Documentation) which will help you get familiar with the API and get to know more about the Xcode projects structure. - ## References 📚 - [Xcode Project File Format](http://www.monobjc.net/xcode-project-file-format.html) diff --git a/RELEASE.md b/RELEASE.md deleted file mode 100644 index 4b8c5c729..000000000 --- a/RELEASE.md +++ /dev/null @@ -1,10 +0,0 @@ -# Releasing - -In this document you'll find all the necessary steps to release a new version of `xcodeproj`: - -1. Make sure you are in the `main` branch. -2. Determine the next version based on the unreleased changes. -3. Add the version section to the `CHANGELOG.md`, update the versions in the `README.md`. -4. Commit the changes and tag them `git commit -m "Version x.y.z"` & `git tag x.y.z`. -5. Push the changes `git push origin main --tags` -6. Create the release on GitHub including the release notes from the `CHANGELOG.md`.