Skip to content

Commit

Permalink
Updating and moving release checklist (#97)
Browse files Browse the repository at this point in the history
  • Loading branch information
BobaFetters authored Oct 23, 2023
1 parent b8ea5cb commit 46674ba
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 6 deletions.
Original file line number Diff line number Diff line change
@@ -1,17 +1,16 @@
#### Diff
<!-- _Change this to show the diff since the last version._ -->
[See diff since last version](https://github.com/apollographql/apollo-ios/compare/${PREVIOUS_VERSION_TAG}...{$VERSION_BRANCH}).

#### Relevant changes:
<!-- _List the highlight PRs_ -->
[See diff since last version](https://github.com/apollographql/apollo-ios-dev/compare/${PREVIOUS_VERSION_TAG}...{$VERSION_BRANCH}).

#### Things to do in this PR
- [ ] Update the version constants using the `set-version.sh` script.
- [ ] Update [`CHANGELOG.md`](https://github.com/apollographql/apollo-ios/blob/main/CHANGELOG.md) with all relevant changes since the prior version. _Please include PR numbers and mention contributors for external PR submissions._
- [ ] Run the Documentation Generator from the internal `SwiftScripts` folder using the command `swift run DocumentationGenerator` to re-generate the API reference documentation from source for all included libraries. _Make sure you are on HEAD of the parent branch otherwise the documentation generator will not catch all changes, rebase this PR if needed._
- [ ] Run `make archive-cli-to-apollo-package` to attach cli to apollo-ios package

#### Things to do as part of releasing
- [ ] Add tag of format `major.minor.patch` to GitHub.
- [ ] Create a release on GitHub with the new tag, using the latest [`CHANGELOG.md`](https://github.com/apollographql/apollo-ios/blob/main/CHANGELOG.md) contents.
- [ ] Attach CLI binary to the GitHub release. _Use the `make archive-cli-for-release` command which builds both Intel and ARM architectures, and creates the tar archive for you._
- [ ] Run `pod trunk push Apollo.podspec` to publish to CocoaPods. _You will need write permissions for this, please contact one of the [maintainers](https://github.com/apollographql/apollo-ios/blob/main/README.md#maintainers) if you need access to do this._
- [ ] Run `pod trunk push Apollo.podspec` and `pod trunk push ApolloTestSupport.podspec` to publish to CocoaPods. _You will need write permissions for this, please contact one of the [maintainers](https://github.com/apollographql/apollo-ios/blob/main/README.md#maintainers) if you need access to do this._
- [ ] Run "[Release New Version](https://github.com/apollographql/apollo-ios-xcframework/actions/workflows/release-new-version.yml)" workflow in `apollo-ios-xcframework`
1 change: 1 addition & 0 deletions RELEASE_CHECKLIST.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
The release checklist has been moved to a [Pull Request template](https://github.com/apollographql/apollo-ios-dev/blob/main/.github/PULL_REQUEST_TEMPLATE/pull-request-template-release.md). Unfortunately Pull Request templates aren't offered as a selection list when creating a new Pull Request, nor can a static link be used. To get the template contents in your new Pull Request you need to manually append the query parameter `template=pull-request-template-release.md` in the address bar once you've selected the compare branches.
1 change: 0 additions & 1 deletion apollo-ios/RELEASE_CHECKLIST.md

This file was deleted.

0 comments on commit 46674ba

Please sign in to comment.