Skip to content

Commit a2382e5

Browse files
committed
Fixing Release Instructions
1 parent f975a9a commit a2382e5

File tree

5 files changed

+32
-35
lines changed

5 files changed

+32
-35
lines changed

Gemfile

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
source 'https://rubygems.org'
22

3+
gem 'cocoapods-trunk', '>=1.5.0'
34
gem 'cocoapods'
45

56
gem 'cocoapods-generate'

Gemfile.lock

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,7 @@ GEM
4848
nap
4949
cocoapods-search (1.0.0)
5050
cocoapods-stats (1.1.0)
51-
cocoapods-trunk (1.4.1)
51+
cocoapods-trunk (1.5.0)
5252
nap (>= 0.8, < 2.0)
5353
netrc (~> 0.11)
5454
cocoapods-try (1.1.0)
@@ -89,6 +89,7 @@ PLATFORMS
8989
DEPENDENCIES
9090
cocoapods
9191
cocoapods-generate
92+
cocoapods-trunk (>= 1.5.0)
9293

9394
BUNDLED WITH
9495
2.1.4

RELEASING.md

Lines changed: 23 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,17 @@
44

55
---
66

7-
***Before you begin:*** *Please make sure you are set up with
7+
***Before you begin:*** Please make sure you are set up with
88
[`pod trunk`](https://guides.cocoapods.org/making/getting-setup-with-trunk.html) and your CocoaPods
99
account is a contributor to both the Workflow and WorkflowUI pods. If you need to be added as a
1010
contributor, please [open a ticket requesting access](https://github.com/square/workflow-swift/issues/new),
11-
and assign it to @bencochran or @aquageek.*
11+
and assign it to @bencochran, @aquageek or @dhavalshreyas.
1212

1313
---
14-
1. Merge an update of [the change log](CHANGELOG.md) with the changes since the last release.
14+
15+
1. Merge an update of [the change log](CHANGELOG.md) with changes since the last release.
16+
17+
1. If there has been a **Breaking Change**, since last release, update `VERSION` and bump up `MAJOR`.
1518

1619
1. Make sure you're on the `main` branch (or fix branch, e.g. `v0.1-fixes`).
1720

@@ -21,15 +24,26 @@ and assign it to @bencochran or @aquageek.*
2124
git tag v0.1.0
2225
```
2326

27+
1. Push your commits and tag:
28+
```
29+
git push origin main
30+
# or git push origin fix-branch
31+
git push origin v0.1.0
32+
```
33+
2434
1. Publish to CocoaPods:
2535
```bash
26-
bundle exec pod trunk push Workflow.podspec
27-
bundle exec pod trunk push WorkflowTesting.podspec
28-
bundle exec pod trunk push WorkflowUI.podspec
36+
bundle exec pod trunk push Workflow.podspec --synchronous
37+
bundle exec pod trunk push WorkflowTesting.podspec --synchronous
38+
bundle exec pod trunk push WorkflowReactiveSwift.podspec --synchronous
39+
bundle exec pod trunk push WorkflowUI.podspec --synchronous
40+
bundle exec pod trunk push WorkflowRxSwift.podspec --synchronous
41+
bundle exec pod trunk push WorkflowReactiveSwiftTesting.podspec --synchronous
42+
bundle exec pod trunk push WorkflowRxSwiftTesting.podspec --synchronous
43+
bundle exec pod trunk push WorkflowSwiftUI.podspec --synchronous
2944
```
3045

31-
1. Bump the version
32-
- **Swift:** Update `s.version` in `*.podspec` to the new version, e.g. `0.2.0`.
46+
1. Bump the version: Update `VERSION` to the new version, e.g. `0.2.0`.
3347

3448
1. Commit the new snapshot version:
3549
```
@@ -60,24 +74,4 @@ and assign it to @bencochran or @aquageek.*
6074
git merge --no-ff v0.1-fixes
6175
# Resolve conflicts. Accept main's versions of gradle.properties and podspecs.
6276
git push origin main
63-
```
64-
65-
1. Publish the website. See https://github.com/square/workflow/blob/main/RELEASING.md.
66-
67-
### Validating Markdown
68-
69-
Since all of our high-level documentation is written in Markdown, we run a linter in CI to ensure
70-
we use consistent formatting. Lint errors will fail your PR builds, so to run locally, install
71-
[markdownlint](https://github.com/markdownlint/markdownlint):
72-
73-
```bash
74-
gem install mdl
75-
```
76-
77-
Run the linter using the `lint_docs.sh`:
78-
79-
```bash
80-
./lint_docs.sh
81-
```
82-
83-
Rules can be configured by editing `.markdownlint.rb`.
77+
```

WorkflowUI.podspec

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,7 @@ Pod::Spec.new do |s|
1919
s.source_files = 'WorkflowUI/Sources/**/*.swift'
2020

2121
s.dependency 'Workflow', "#{s.version}"
22+
s.dependency 'WorkflowReactiveSwift', "#{s.version}"
2223

2324
s.test_spec 'Tests' do |test_spec|
2425
test_spec.source_files = 'WorkflowUI/Tests/**/*.swift'

version.rb

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
load('VERSION')
2-
3-
pre_release_append = ((PRE_RELEASE_IDENTIFIER ||= "") != "") ? "-"+PRE_RELEASE_IDENTIFIER : ""
4-
5-
WORKFLOW_VERSION="#{MAJOR}.#{MINOR}.#{PATCH}#{pre_release_append}"
1+
if !Object.const_defined?(:WORKFLOW_VERSION)
2+
load('VERSION')
3+
pre_release_append = ((PRE_RELEASE_IDENTIFIER ||= "") != "") ? "-"+PRE_RELEASE_IDENTIFIER : ""
4+
WORKFLOW_VERSION="#{MAJOR}.#{MINOR}.#{PATCH}#{pre_release_append}"
5+
end

0 commit comments

Comments
 (0)