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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

馃摑 Remove Package.swift, add details to readme #12

Merged
merged 2 commits into from Jun 13, 2022

Conversation

phatblat
Copy link
Member

@phatblat phatblat commented Jun 13, 2022

We've decided to not bother with updating the main branch to simplify deployment of our SwiftPM package release. This PR removes the Package.swift file from the repo and adds details to the readme for how users can find more info. After this change, the main branch is effectively just a README.md for humans and a link to the tags page where new versions will show up.

Also, the link to our iOS installation docs was broken as the URL has changed recently.

@phatblat phatblat added the A-documentation Area: documentation label Jun 13, 2022
@phatblat phatblat self-assigned this Jun 13, 2022
@konstantinbe konstantinbe changed the title 馃摑 Remove Package.swift, add details to readme. 馃摑 Remove Package.swift, add details to readme Jun 13, 2022
Copy link

@konstantinbe konstantinbe left a comment

Choose a reason for hiding this comment

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

Perfect. 馃憣

README.md Show resolved Hide resolved
@phatblat phatblat merged commit 17a8ab4 into main Jun 13, 2022
@phatblat phatblat deleted the ben/remove-package branch June 13, 2022 18:51
@daveverwer
Copy link

Really sorry to resurrect an old PR with a new comment, but someone working with some new search functionality for the Swift Package Index came across the fact that the Package.swift file has been removed from this repo.

We rely really heavily on there being a Package.swift on the default branch to determine lots of the package metadata that we display on the package page. Removing one from a project that originally had one doesn't cause immediate problems, but we do remove packages that do this as they wouldn't pass validation if submitted in this state.

I'm writing a note here as it's going to break your SPI badges that you added to your README. We're thinking about ways to deal with this issue, but it's a situation that's quite tricky for us to cope with.

Hope it was OK to leave a note here!

@phatblat
Copy link
Member Author

phatblat commented Aug 1, 2022

Thanks for the reminder! This has been brought up a few times and we're planning to resurrect it, just need our deployment to update the main branch instead of creating orphaned branches (which was a little easier).

@daveverwer
Copy link

Ah, that's great news! Thanks for the very quick reply!

I've removed it from the index for now, but please do feel free to re-add it as soon as there's a Package.swift file again.

@phatblat
Copy link
Member Author

phatblat commented Aug 1, 2022

Created issue #16 to track

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-documentation Area: documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants