You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Release of version 0.6.0
See below the full CHANGELOG details.
Added:
- [DemoApp] Update color screen to add a border on color illustration square ([#280](#280))
- [DemoApp] Add grid tokens screen in demo app ([#151](#151))
- [Tool] GitHub Action to run SwiftLint for *main* and *develop* branches
Changed:
- [Tool] Update `net-http` gem from 0.4.1 to 0.5.0 ([#286](#286))
- [Tool] Update `cocoapods` gem from 1.15.2 to 1.16.2 ([#286](#286))
- [Tool] Update `json` gem from 2.7.2 to 2.8.2 ([#286](#286))
- [Tool] Update `swiftformat/cli` from 0.54.3 to 0.54.6 ([#286](#286))
- [Tool] Update `Fastlane` from 2.223.1 to 2.225.0 ([#286](#286))
- [DemoApp] Update accessibility statement usage and instructions ([#278](#278))
Fixed:
- [DemoApp] Add missing accessibility label for images ([#212](#212))
- [DemoApp] Fix text sizes when dynamic type is used (a11y) ([#247](#247))
Co-authored-by: Pierre-Yves Lapersonne <[email protected]>
Co-authored-by: Ludovic Pinel <[email protected]>
Co-authored-by: Tayeb Sedraia <[email protected]>
Copy file name to clipboardExpand all lines: .github/CONTRIBUTING.md
+7-1
Original file line number
Diff line number
Diff line change
@@ -148,7 +148,6 @@ Because we want to define and provide an amazing design system for developers, w
148
148
149
149
The following chart explain how the review is done with also the intermediate alpha builds.
150
150
In few words, alpha builds are made for reviewers, and the merge is processed if and only if any review have been done.
151
-
The [task-list-completed GitHub app](https://github.com/apps/task-list-completed) prevents pull requests to be merged if some mandatory / not optional prerequisites are not filled.
152
151
153
152
```mermaid
154
153
flowchart TD
@@ -172,6 +171,13 @@ flowchart TD
172
171
L --> M(Update GitHub issue with details of beta build)
173
172
```
174
173
174
+
Pull requests will be merged if no conditions / prerequisites / checks are red (except DCO which is not - yet - mandatory, but we must at least outside contributors to apply it). Some _GitHub Actions_ workflows are defined:
175
+
-[task-list-completed GitHub app](https://github.com/apps/task-list-completed) prevents pull requests to be merged if some mandatory / not optional prerequisites are not filled ;
176
+
- another [workflow YAML](https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/workflows/build-and-test.yml) building and testing the app / lib;
177
+
- another [using GitLeaks](https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/workflows/gitleaks-action.yml) ensuring no screts are leaked ;
178
+
- the almost-optional-one checking [DCO is applied](https://probot.github.io/apps/dco/) ;
179
+
- and the one [for the linter warnings](https://github.com/cirruslabs/swiftlint-action).
180
+
175
181
## License
176
182
177
183
By contributing your code, you agree to license your contribution under the [MIT License](LICENSE).
Copy file name to clipboardExpand all lines: .github/DEVELOP.md
+22-8
Original file line number
Diff line number
Diff line change
@@ -181,6 +181,8 @@ A [GitHub Action bot](https://probot.github.io/apps/dco/) has been plugged in th
181
181
182
182
### About commits
183
183
184
+
#### Convention commits rules
185
+
184
186
Try as best as possible to apply [conventional commits rules](https://www.conventionalcommits.org/en/v1.0.0/).
185
187
Keep in mind to have your commits well prefixed, and with the issue number between parenthesis at the end, and also if needed the pull request issue number.
186
188
If your commits embed contributions for other people, do not forget to [add them as co-authors](https://docs.github.com/fr/pull-requests/committing-changes-to-your-project/creating-and-editing-commits/creating-a-commit-with-multiple-authors).
@@ -203,26 +205,36 @@ You can add also ! after the keyword to say a breaking change occurs, and also a
203
205
-`feat(API)!:` breaking change in the API because..
204
206
-`feat:` add something in the API...
205
207
206
-
For example, given a commit to fix the issue n°42, the commit should be like:
208
+
#### Chain of responsability
209
+
210
+
We can add metafields picked from [this good guideline](https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git/tree/Documentation/process/submitting-patches.rst#n525) in the commit messages.
211
+
212
+
This is not mandatory (yet) but a good practice and quite interesting to know who reviewed and validated what.
213
+
214
+
For example, given a commit to fix the issue n°42, with Foo FOO and Bar BAR as commit authors, with Wizz WIZZ as source code reviewer, and John DOE as accessibility / PO / design reviewer, the commit should be like:
207
215
208
216
```text
209
217
fix: title of your commit (#42)
210
218
211
219
Some details about the fix you propose
212
220
213
-
Co-authored-by: First author firstname and lastname <first author email>
214
-
Co-authored-by: Second author firstname and lastname <second author email>
221
+
Co-authored-by: Foo FOO <foo email>
222
+
Co-authored-by: Bar BAR <bar email>
215
223
216
-
Signed-off-by: First author firstname and lastname <first author email>
217
-
Signed-off-by: Second author firstname and lastname <second author email>
224
+
Reviewed-by: Wizz WIZZ <wizz email>
225
+
226
+
Acked-by: John DOE <john email>
227
+
228
+
Signed-off-by: Foo FOO <foo email>
229
+
Signed-off-by: Bar BAR <bar email>
218
230
```
219
231
220
232
### About release note and changelog
221
233
222
234
We try also to apply [keep a changelog](https://keepachangelog.com/en/1.0.0/), and [semantic versioning](https://semver.org/spec/v2.0.0.html) both with [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/).
223
235
224
236
We do not generate yet `RELEASE_NOTE.md` file using the Git history and [git cliff](https://git-cliff.org/) tool.
225
-
Today we update the unique CHANGELOG manualy, but you can find [in the wiki more details about the use of git-cliff](https://github.com/Orange-OpenSource/ouds-ios/wiki/7-%E2%80%90-About-changelog,-release-notes-and-hooks)
237
+
Today we update the unique CHANGELOG manualy, but you can find [in the wiki more details about the use of git-cliff](https://github.com/Orange-OpenSource/ouds-ios/wiki/8-%E2%80%90-About-changelog,-release-notes-and-hooks)
226
238
227
239
## Use of Gitleaks
228
240
@@ -288,20 +300,22 @@ Do not forget if possible to enable the warnings in the end of the file to reduc
288
300
### GitHub Action
289
301
290
302
We use also *GitHub Actions* so as to define a workflow with some actions to build demo application and test the library.
291
-
It will help use to ensure code on pull requests or being merged compiles and has all tests green.
303
+
It will help us to ensure code on pull requests or being merged compiles and has all tests green.
292
304
This workflow is defined in [this YAML](https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/workflows/build-and-test.yml)
293
305
294
306
We have also a *gitleaks* workflow making some scans on the code to loook fo secrets leaks, defined in [this YAML](https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/workflows/gitleaks-action.yml).
295
307
296
308
We use also two GitHub apps making controls on pull requests and defining wether or not prerequisites are filled or not.
297
309
There is on control to check if [PR template are all defined ](https://github.com/stilliard/github-task-list-completed), and one if [DCO is applied](https://probot.github.io/apps/dco/).
298
310
311
+
Finaly we have [this *GitHub Action*](https://github.com/cirruslabs/swiftlint-action) using _SwiftLint_ to ensure no warnings are in our codebase.
312
+
299
313
### GitLab CI (internal)
300
314
301
315
We use *GitLab CI*for CI/CD with our own runners so as to keep private our sensitive files likes certificates and provisioning profiles.
302
316
Our currant plan does not allow to make GitHub mirroring, so we use GitHub HTTP REST API to download sources, before using Xcode to build and sign.
303
317
However of course you will have to define all the variables, secrets and have the mandatory files.
304
318
305
-
You can find more details about the pipelines, how to set up runners and scripts to use [in the wiki](https://github.com/Orange-OpenSource/ouds-ios/wiki/5-%E2%80%90-About-continuous-integration-and-delivery).
319
+
You can find more details about the pipelines, how to set up runners and scripts to use [in the wiki](https://github.com/Orange-OpenSource/ouds-ios/wiki/9-%E2%80%90-About-continuous-integration-and-delivery).
306
320
307
321
In few words, there is a pipeline containing some stages and jobs to build alpha, nightly/beta and production releases.
-[DemoApp] Update color screen to add a border on color illustration square ([#280](https://github.com/Orange-OpenSource/ouds-ios/issues/280))
12
+
-[DemoApp] Add grid tokens screen in demo app ([#151](https://github.com/Orange-OpenSource/ouds-ios/issues/151))
13
+
-[Tool] GitHub Action to run SwiftLint for *main* and *develop* branches
14
+
15
+
### Changed
16
+
17
+
-[Tool] Update `net-http` gem from 0.4.1 to 0.5.0 ([#286](https://github.com/Orange-OpenSource/ouds-ios/issues/286))
18
+
-[Tool] Update `cocoapods` gem from 1.15.2 to 1.16.2 ([#286](https://github.com/Orange-OpenSource/ouds-ios/issues/286))
19
+
-[Tool] Update `json` gem from 2.7.2 to 2.8.2 ([#286](https://github.com/Orange-OpenSource/ouds-ios/issues/286))
20
+
-[Tool] Update `swiftformat/cli` from 0.54.3 to 0.54.6 ([#286](https://github.com/Orange-OpenSource/ouds-ios/issues/286))
21
+
-[Tool] Update `Fastlane` from 2.223.1 to 2.225.0 ([#286](https://github.com/Orange-OpenSource/ouds-ios/issues/286))
22
+
-[DemoApp] Update accessibility statement usage and instructions ([#278](https://github.com/Orange-OpenSource/ouds-ios/issues/278))
23
+
24
+
### Fixed
25
+
26
+
-[DemoApp] Add missing accessibility label for images ([#212](https://github.com/Orange-OpenSource/ouds-ios/issues/212))
27
+
-[DemoApp] Fix text sizes when dynamic type is used (a11y) ([#247](https://github.com/Orange-OpenSource/ouds-ios/issues/247))
0 commit comments