4
4
5
5
---
6
6
7
- *** Before you begin:*** * Please make sure you are set up with
7
+ *** Before you begin:*** Please make sure you are set up with
8
8
[ ` pod trunk ` ] ( https://guides.cocoapods.org/making/getting-setup-with-trunk.html ) and your CocoaPods
9
9
account is a contributor to both the Workflow and WorkflowUI pods. If you need to be added as a
10
10
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 .
12
12
13
13
---
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 ` .
15
18
16
19
1 . Make sure you're on the ` main ` branch (or fix branch, e.g. ` v0.1-fixes ` ).
17
20
@@ -21,15 +24,26 @@ and assign it to @bencochran or @aquageek.*
21
24
git tag v0.1.0
22
25
```
23
26
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
+
24
34
1 . Publish to CocoaPods:
25
35
``` 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
29
44
```
30
45
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` .
33
47
34
48
1. Commit the new snapshot version:
35
49
```
@@ -60,24 +74,4 @@ and assign it to @bencochran or @aquageek.*
60
74
git merge --no-ff v0.1-fixes
61
75
# Resolve conflicts. Accept main's versions of gradle.properties and podspecs.
62
76
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
+ ```
0 commit comments