Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Configuration for open sourcing #88

Merged
merged 12 commits into from
Dec 2, 2024
Merged

Conversation

jonryser
Copy link
Collaborator

@jonryser jonryser commented Nov 27, 2024

Describe the changes

  • The Developer Team and Bundle ID can be configured via environment variables (in the build.xcconfig). This keeps the Allen Inst or GenUI values out of the repo.
  • Also added instructions for a user to add their own.
  • By default, DEBUG is configured to "Sign to Run Locally"
  • Moved documentation images to the repo itself so that they may be viewed locally.
  • I have added the Allen Inst Developer Team Id and the App Bundle Id to 1Password

Issue ticket number and link

#11

Checklist before requesting a review

  • My code adheres to the coding and style guidelines of the project.
  • I have performed a self-review of my code.
  • I have tested my changes and ensured that they work as expected.
  • I have updated examples and documentation as necessary.


4. Select the project in the Project Navigator.
1) In configurations ensure "Debug and Release" is set to use `release.xcconfig`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We may actually want to refer to debug.xconfig for debug / development builds.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I was thinking that too. But it may create more initial complexity than needed for open sourcing. We can and other developers could, of course, refine the configuration to their needs. But perhaps a single file for now.

Copy link
Collaborator

@ThomasJones ThomasJones left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks great. The only think I mentioned was maybe we support a debug.xconfig, or consider renaming release.xconfig merely to build.xconfig. It feels strange and a bit non-standard for debug to point to something referred to as 'release'.

@jonryser
Copy link
Collaborator Author

Looks great. The only think I mentioned was maybe we support a debug.xconfig, or consider renaming release.xconfig merely to build.xconfig. It feels strange and a bit non-standard for debug to point to something referred to as 'release'.

Yeah, I agree and like that better. I'll change it to build.xcconfig.

@Stanley-Jovel
Copy link
Collaborator

Stanley-Jovel commented Nov 28, 2024

Initially I could not build the app and got this message:
""OLMoE.swift" has entitlements that require signing with a development certificate.
Enable development signing in the Signing & Capabilities editor."

To get it to build I had to "Enable Development Signing". Locally is working again but can we be sure this won't be a problem during release?

@jonryser
Copy link
Collaborator Author

jonryser commented Dec 2, 2024

Initially I could not build the app and got this message: ""OLMoE.swift" has entitlements that require signing with a development certificate. Enable development signing in the Signing & Capabilities editor."

To get it to build I had to "Enable Development Signing". Locally is working again but can we be sure this won't be a problem during release?

@Stanley-Jovel - Could we connect on this? I'd like to see what you had to change.

@jonryser jonryser linked an issue Dec 2, 2024 that may be closed by this pull request
Copy link
Collaborator

@Stanley-Jovel Stanley-Jovel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Readme looks great

@jonryser jonryser merged commit bd526ee into release-20241118 Dec 2, 2024
1 check passed
@Stanley-Jovel Stanley-Jovel deleted the ready-4-opensource branch December 2, 2024 20:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[P2] Code cleanup, quality, ready for open-source
3 participants