Skip to content

[docs]: update releasing docs #178

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.

Sign up for GitHub

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

Merged
merged 3 commits into from
Jan 10, 2023
Merged

[docs]: update releasing docs #178

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e2e37d8
[docs]: update releasing instructions
jamieQ Jan 10, 2023
cc42001
formatting
jamieQ Jan 10, 2023
9976919
formatting2
jamieQ Jan 10, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions RELEASING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,15 @@ For Squares, membership is managed through the `Workflow Swift Owners` registry

---

> ⚠️ [Optional] To avoid possible headaches when publishing podspecs, validation can be performed before updating the Workflow version number(s). To do this, run the following in the root directory of this repo:
> ```bash
> bundle exec pod lib lint Workflow.podspec WorkflowTesting.podspec WorkflowReactiveSwift.podspec WorkflowUI.podspec WorkflowRxSwift.podspec WorkflowReactiveSwiftTesting.podspec WorkflowRxSwiftTesting.podspec WorkflowSwiftUI.podspec WorkflowCombine.podspec WorkflowCombineTesting.podspec
> ```
> And then run a similar command to check the `WorkflowConcurrency*` libraries. These specs will fail default validation as their version differs from the git tag used, so run the command with the `--allow-warnings` option, and check that only that warning is produced.
> ```bash
> bundle exec pod lib lint WorkflowConcurrency.podspec WorkflowConcurrencyTesting.podspec --allow-warnings
> ```

1. Update `VERSION` file based on [`semver`](https://semver.org/).

1. Create a PR with the version change and merge to `main`.
Expand All @@ -38,6 +47,9 @@ For Squares, membership is managed through the `Workflow Swift Owners` registry
bundle exec pod trunk push WorkflowSwiftUI.podspec --synchronous
bundle exec pod trunk push WorkflowCombine.podspec --synchronous
bundle exec pod trunk push WorkflowCombineTesting.podspec --synchronous

# Note: If the following fail due to a validation warning about their version number not matching the git tag,
# it is safe to ignore, and publish anyway by adding the `--allow-warnings` option to the command.
bundle exec pod trunk push WorkflowConcurrency.podspec --synchronous
bundle exec pod trunk push WorkflowConcurrencyTesting.podspec --synchronous
```
Expand Down