Skip to content

Commit fe2f926

Browse files
ChipSergioEstevao
andauthored
Release 1.19.3 (#1297)
* Add release documentation. * Fix style in documentation. * Fix some errors and add links. * [Gutenberg] Correct Color for RichText links in Dark Mode - Expose helper method (#1295) * Expose the color coversion helper for use in subclasses * Revert Podfile version bump * Fix lint error * Bump Version number * Update changelog Co-authored-by: Sergio Estevao <sergioestevao@gmail.com>
1 parent 93f0a5a commit fe2f926

File tree

6 files changed

+134
-11
lines changed

6 files changed

+134
-11
lines changed

Aztec.xcodeproj/project.pbxproj

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -235,6 +235,7 @@
235235
FF437B6620D7CB83000D9666 /* LiFormatter.swift in Sources */ = {isa = PBXBuildFile; fileRef = FF437B6520D7CB83000D9666 /* LiFormatter.swift */; };
236236
FF48CAC8234DD5D3007FFC79 /* NSMutableAttributedString+ReplaceAttributes.swift in Sources */ = {isa = PBXBuildFile; fileRef = FF48CAC7234DD5D3007FFC79 /* NSMutableAttributedString+ReplaceAttributes.swift */; };
237237
FF4E26601EA8DF1E005E8E42 /* ImageAttachment.swift in Sources */ = {isa = PBXBuildFile; fileRef = FF4E265F1EA8DF1E005E8E42 /* ImageAttachment.swift */; };
238+
FF5DCBF2248ED900006D9FC7 /* ReleaseProcess.md in Resources */ = {isa = PBXBuildFile; fileRef = FF5DCBF1248ED900006D9FC7 /* ReleaseProcess.md */; };
238239
FF61909E202481F4004BCD0A /* CodeFormatter.swift in Sources */ = {isa = PBXBuildFile; fileRef = FF61909D202481F4004BCD0A /* CodeFormatter.swift */; };
239240
FF7A1C511E5651EA00C4C7C8 /* LineAttachment.swift in Sources */ = {isa = PBXBuildFile; fileRef = FF7A1C501E5651EA00C4C7C8 /* LineAttachment.swift */; };
240241
FF7C89B01E3BC52F000472A8 /* NSAttributedString+FontTraits.swift in Sources */ = {isa = PBXBuildFile; fileRef = FF7C89AF1E3BC52F000472A8 /* NSAttributedString+FontTraits.swift */; };
@@ -521,6 +522,7 @@
521522
FF4E265F1EA8DF1E005E8E42 /* ImageAttachment.swift */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.swift; path = ImageAttachment.swift; sourceTree = "<group>"; };
522523
FF5B98E21DC29D0C00571CA4 /* README.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = net.daringfireball.markdown; path = README.md; sourceTree = SOURCE_ROOT; };
523524
FF5B98E41DC355B400571CA4 /* LICENSE */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = LICENSE; sourceTree = SOURCE_ROOT; };
525+
FF5DCBF1248ED900006D9FC7 /* ReleaseProcess.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = net.daringfireball.markdown; path = ReleaseProcess.md; sourceTree = "<group>"; };
524526
FF61909D202481F4004BCD0A /* CodeFormatter.swift */ = {isa = PBXFileReference; lastKnownFileType = sourcecode.swift; path = CodeFormatter.swift; sourceTree = "<group>"; };
525527
FF7A1C481E51EFB600C4C7C8 /* WordPress-Aztec-iOS.podspec */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text; path = "WordPress-Aztec-iOS.podspec"; sourceTree = "<group>"; };
526528
FF7A1C4A1E51F05700C4C7C8 /* CONTRIBUTING.md */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = net.daringfireball.markdown; path = CONTRIBUTING.md; sourceTree = "<group>"; };
@@ -604,6 +606,7 @@
604606
5951CB841D8BC93600E1866F = {
605607
isa = PBXGroup;
606608
children = (
609+
FF5DCBF0248ED900006D9FC7 /* Documentation */,
607610
FF7A1C481E51EFB600C4C7C8 /* WordPress-Aztec-iOS.podspec */,
608611
FF5B98E41DC355B400571CA4 /* LICENSE */,
609612
FF5B98E21DC29D0C00571CA4 /* README.md */,
@@ -1390,6 +1393,14 @@
13901393
path = Processor;
13911394
sourceTree = "<group>";
13921395
};
1396+
FF5DCBF0248ED900006D9FC7 /* Documentation */ = {
1397+
isa = PBXGroup;
1398+
children = (
1399+
FF5DCBF1248ED900006D9FC7 /* ReleaseProcess.md */,
1400+
);
1401+
path = Documentation;
1402+
sourceTree = "<group>";
1403+
};
13931404
/* End PBXGroup section */
13941405

13951406
/* Begin PBXHeadersBuildPhase section */
@@ -1510,6 +1521,7 @@
15101521
isa = PBXResourcesBuildPhase;
15111522
buildActionMask = 2147483647;
15121523
files = (
1524+
FF5DCBF2248ED900006D9FC7 /* ReleaseProcess.md in Resources */,
15131525
FF1F56A3239562B900E93A30 /* html_colors.json in Resources */,
15141526
FF0714021EFD78AF00E50713 /* Media.xcassets in Resources */,
15151527
);

Aztec/Classes/Extensions/UIColor+Parsers.swift

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import UIKit
22

3-
extension UIColor {
3+
public extension UIColor {
44

55
/// Creates a color based on a hexString. If the string is not a valid hexColor it return nil
66
/// Example of colors: #FF0000, #00FF0000

CHANGELOG.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,7 @@
1+
1.19.3
2+
-------
3+
* Expose UIColor hexString helpers to be used by subclasses of Aztec components.
4+
15
1.19.2
26
-------
37
* Fix drawing of underlines when they include newlines.
@@ -27,14 +31,14 @@
2731
-----
2832
* Improve display of ordered lists with large bullet numbers
2933
* Fix bug where links with text that had a mix of Latin and non-Latin characters were getting split.
30-
34+
3135
1.15.0
3236
-----
3337
* Allow to use headers fonts without bold effect applied
3438
* Support for multilevel blockquotes
3539
* Fix presentation of placeholder images in dark mode.
36-
* Fix bug that didn't set default text color when changing text color
37-
40+
* Fix bug that didn't set default text color when changing text color
41+
3842
1.14.1
3943
-----
4044
* Support for xcode 10.
@@ -48,4 +52,3 @@
4852
-----
4953
* Fix a bug when copying and pasting from other apps when running dark mode.
5054
* Improve list indentation for markers.
51-

Documentation/ReleaseProcess.md

Lines changed: 112 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
## Release Process ##
2+
3+
### Step 1: Creating a release branch ###
4+
5+
The branch structure in Aztec iOS is based on the [Git Flow](https://nvie.com/posts/a-successful-git-branching-model/) methodology.
6+
7+
These are the main branches involved in the release process:
8+
```
9+
master: Kept up to date with the latest release.
10+
develop: Bleeding edge branch with all of the latest changes.
11+
release/x.y.z: Version branch, which we will use during the release process.
12+
```
13+
The first step in the process is creating the version branch.
14+
15+
The version branch is what allows work to continue in develop while also having a frozen snapshot of what we’re releasing.
16+
17+
Using the command line, the process is pretty straightforward:
18+
19+
```
20+
git checkout develop
21+
git pull
22+
git checkout -b release/x.y.z
23+
git push origin -u release/x.y.z
24+
```
25+
26+
Make sure to update the field `s.version` in both of these files to the `x.y.z` number
27+
```
28+
WordPress-Aztec-iOS.podspec
29+
WordPress-Editor-iOS.podespec
30+
```
31+
32+
Open a PR on github where you target the `master` branch with the `release/x.y.z` branch and call it `Release x.y.z`
33+
34+
35+
### Step 2: Testing the Integration ###
36+
37+
Before going any further, tt's normally good practice to test the Aztec integration into [WordPress-iOS project](https://github.com/wordpress-mobile/WordPress-iOS), to make sure we won’t have to do the release process twice.
38+
39+
Make sure WordPress-iOS’s podfile specifies the SAME (and latest) commit number for both of these:
40+
```
41+
pod 'WordPress-Aztec-iOS', :git => 'https://github.com/wordpress-mobile/AztecEditor-iOS.git', :commit => 'e0fc55abb4809b3b23b6d8b56791798af864025d'
42+
pod 'WordPress-Editor-iOS', :git => 'https://github.com/wordpress-mobile/AztecEditor-iOS.git', :commit => 'e0fc55abb4809b3b23b6d8b56791798af864025d'
43+
```
44+
The things we want to look out for are:
45+
46+
- That the pod can be properly installed in WPiOS.
47+
- That WPiOS builds properly.
48+
- That you can open a post through the App, using both the classic editor and Gutenberg.
49+
50+
### Step 3: Merge the branch ###
51+
52+
If the release PR is approved and all is working correctly in WP-iOS merge the release branch to master.
53+
54+
### Step 4: Push the POD. ###
55+
56+
*Automated Process*
57+
58+
Create a new release on Github targetting the master branch and name it `Release x.y.z`
59+
60+
Set a tag with the value `x.y.z` .
61+
62+
On the description field and the content of the changelog for this version
63+
64+
Press the `Publish release` button
65+
66+
At this moment the CI automation should notice your tag and after some minutes you should get the new pod publish on CocoaPods master trunk.
67+
68+
If this for some reason fails chech the manual process bellow
69+
70+
*Manual Process*
71+
72+
Pushing the PODs is a bit different than in other repos due to the fact that this repo has two podspecs.
73+
74+
The recommended steps are:
75+
76+
Lint the core library
77+
```
78+
bundle exec pod lib lint WordPress-Aztec-iOS.podspec
79+
```
80+
81+
If all is good proceed to
82+
```
83+
bundle exec pod trunk push WordPress-Aztec-iOS.podspec
84+
```
85+
86+
Then lint the Editor library
87+
```
88+
bundle exec pod lib lint WordPress-Editor-iOS.podspec
89+
```
90+
91+
If all is good, push it
92+
```
93+
bundle exec pod trunk push WordPress-Editor-iOS.podspec
94+
```
95+
96+
### Step 5: Closing the milestone ###
97+
98+
For simplicity Aztec uses a single milestone named “Next Stable”. The purpose of this milestone is to be used to assign to it all of the regular issues that are closed and merged into develop during the regular development process.
99+
100+
At this point in the release process you should rename the milestone to the version you've just released.
101+
102+
Once renamed, you can create a new “Next Stable” milestone and assign all pending open issues to it.
103+
104+
At this point you’re ready to close the version milestone in GitHub.
105+
106+
### Step 6: Merge Master to develop ###
107+
108+
Following the git Flow methodology you now need to merge the master branch back to develop.
109+
110+
Create a new PR in GitHub that targets `develop` with the master branch.
111+
112+
After review, if all is ok, merge that PR and your work is done.

WordPress-Aztec-iOS.podspec

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
Pod::Spec.new do |s|
1010
s.name = 'WordPress-Aztec-iOS'
11-
s.version = '1.19.2'
11+
s.version = '1.19.3'
1212
s.summary = 'The native HTML Editor.'
1313

1414
# This description is used to generate tags and improve search results.
@@ -41,5 +41,3 @@ Pod::Spec.new do |s|
4141
s.xcconfig = {'OTHER_LDFLAGS' => '-lxml2',
4242
'HEADER_SEARCH_PATHS' => '/usr/include/libxml2'}
4343
end
44-
45-

WordPress-Editor-iOS.podspec

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

99
Pod::Spec.new do |s|
1010
s.name = 'WordPress-Editor-iOS'
11-
s.version = '1.19.2'
11+
s.version = '1.19.3'
1212
s.summary = 'The WordPress HTML Editor.'
1313

1414
# This description is used to generate tags and improve search results.
@@ -39,5 +39,3 @@ Pod::Spec.new do |s|
3939

4040
s.dependency "WordPress-Aztec-iOS", s.version.to_s
4141
end
42-
43-

0 commit comments

Comments
 (0)