search

apple / swift-docc

Documentation compiler that produces rich API reference documentation and interactive tutorials for your Swift framework or package.
https://swift.org/documentation/docc
Apache License 2.0
1.14k stars 118 forks source link

[NFC] .github: Link out to Swift.org for release branch PR form #940

Open AnthonyLatsis opened 4 weeks ago

AnthonyLatsis commented 4 weeks ago

Summary

In an effort to centralize the release branch PR form and release process info in general, remove any instances of such content and link out to the dedicated section on Swift.org instead.

This move was agreed upon by the Contributor Experience Workgroup.

Concurrent PRs:

Checklist

This change is NFC.

AnthonyLatsis commented 2 weeks ago

I'd like to suggest we add a new .github repo on swiftlang and add PULL_REQUEST_TEMPLATE/CHERRY_PICK.md file on this repo.

Yep, that was the original idea — suboptimal for apple, but much better for swiftlang. We’re going to discuss this next meeting (I was the one to originally bring up this topic and nobody seemed to be anticipating swiftlang at the time).

@parispittman Do we have a rough estimate on the time frame of repository transfers to swiftlang?

Kyle-Ye commented 2 weeks ago

I'd like to suggest we add a new .github repo on swiftlang and add PULL_REQUEST_TEMPLATE/CHERRY_PICK.md file on this repo.

Yep, that was the original idea — suboptimal for apple, but much better for swiftlang. We’re going to discuss this next meeting (I was the one to originally bring up this topic and nobody seemed to be anticipating swiftlang at the time).

@parispittman Do we have a rough estimate on the time frame of repository transfers to swiftlang?

I saw the transition has already began.

I suggest we just use "the original idea".

For those repo still hosted on apple currently (eg. swift-docc), we can continue use the old pattern.

When the migration is done for them, we can then just safely delete the duplicated .github/PULL_REQUEST_TEMPLATE/CHERRY_PICK.md file on those repo.

AnthonyLatsis commented 1 week ago

Turns out, folks have already added a .github repository to swiftlang, so I went ahead and added the org-wide pull request template. It works as a query parameter just fine. The template is called release.md — I think this neutral and simple if straightforward name will be easiest for us all to remember and type. I will update this pull request accordingly as soon as the repo moves to swiftlang.

Thanks for weighing in!