Skip to content

Commit

Permalink
Update Docs re: Xcodegen changes
Browse files Browse the repository at this point in the history
Summary: $title

Reviewed By: jamestouri

Differential Revision: D29457737

fbshipit-source-id: f6dc726dd4a88b021db2d129b5894c1f2911f985
  • Loading branch information
joesus authored and facebook-github-bot committed Jun 30, 2021
1 parent 87e4e9c commit 5a54650
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 1 deletion.
8 changes: 8 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,14 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),

## Unreleased

### Changed

- Introduced [Xcodegen](https://github.com/yonaskolb/XcodeGen) for generating project files. Moving forward, We will now use Xcodegen to generate the project files that are used to build the SDK releases. There should be no impact to SDK users. However, some build settings were restored to Xcode defaults as a result of this change, and output binaries may be affected in unpredictable ways. Contributors to the SDK should run the new, top-level script `generate-projects.sh` to ensure that the project files they are using are the same as those being used in CI and for releases. The next major version will remove the project files from version control. If you experience any of these issues, please open an [issue](https://github.com/facebook/facebook-ios-sdk/issues/new/choose) and we will look into it.

### Deprecated

- Building the frameworks using [Carthage](https://github.com/Carthage/Carthage). Carthage is a dependency manager that typically works by building a third party framework using Xcode schemes shared from a `.xcodeproj` file. We are planning to remove the `.xcodeproj` files in the next major release as they will be generated on an as needed basis using [Xcodegen](https://github.com/yonaskolb/XcodeGen). There is a strong likelihood that this change will break several integrations that use Carthage. You will still be able to use Carthage by pulling the pre-built binaries directly from the release. If this does not work for your use case, we recommend checking out Swift Package Manager as an alternative.

[Full Changelog](https://github.com/facebook/facebook-ios-sdk/compare/v11.0.1...HEAD)

## 11.0.1
Expand Down
4 changes: 3 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,4 +14,6 @@ More information on the Apache License can be found [here](http://www.apache.org

Setup:

We use Carthage to manage our dependencies. You will need to run `carthage bootstrap` before you will be able to build the project.
Run `./generate-projects.sh && open FacebookSDK.xcworkspace`. This will generate the Xcode projects and open the workspace.

Note: We use Carthage to include OCMock in some unit tests. You will need to run `carthage bootstrap --no-build` before you will be able to build the tests.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,10 @@ join the [Facebook Developers Group on Facebook](https://www.facebook.com/groups
ask questions on [Stack Overflow](http://facebook.stackoverflow.com),
or open an issue in this repository.

## CONTRIBUTE

Facebook welcomes contributions to our SDKs. Please see the [CONTRIBUTING](CONTRIBUTING) file.

## LICENSE

See the [LICENSE](LICENSE) file.
Expand Down

0 comments on commit 5a54650

Please sign in to comment.