From 0aed787f33760750f079d0cc9f6d75395f6b4a32 Mon Sep 17 00:00:00 2001 From: Pierre-Yves Lapersonne Date: Tue, 26 Nov 2024 13:25:34 +0100 Subject: [PATCH] docs: update wiki references Signed-off-by: Pierre-Yves Lapersonne --- .github/DEVELOP.md | 26 ++++++++++++++----- .../OUDS/Sources/_OUDS.docc/GettingStarted.md | 2 +- OUDS/Core/OUDS/Sources/_OUDS.docc/Tokens.md | 2 +- 3 files changed, 21 insertions(+), 9 deletions(-) diff --git a/.github/DEVELOP.md b/.github/DEVELOP.md index 89d5877e1..4fe083979 100644 --- a/.github/DEVELOP.md +++ b/.github/DEVELOP.md @@ -289,12 +289,24 @@ Signed-off-by: Foo FOO Signed-off-by: Bar BAR ``` +#### Integration of tokenator updates + +You should refer to the [dedicated page in the wiki for more details](https://github.com/Orange-OpenSource/ouds-ios/wiki/20-%E2%80%90-How-to-update-tokens). + +Keep in mind the commit adding *tokenator* updates in the codebase must be formatted like + +```text +chore(🤖): update `OpacityRawTokens` (tokenator generation 20241021134644) (#225) +``` + +i.e. precise the tokens updated, the *tokenator* generation timestamp and the pull request number. + ### About release note and changelog 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/). We do not generate yet `RELEASE_NOTE.md` file using the Git history and [git cliff](https://git-cliff.org/) tool. -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) +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/52-%E2%80%90-About-changelog,-release-notes-and-hooks) ## Use of Gitleaks @@ -359,23 +371,23 @@ Do not forget if possible to enable the warnings in the end of the file to reduc ### GitHub Action -We use also *GitHub Actions* so as to define a workflow with some actions to build demo application and test the library. +We use *GitHub Actions* so as to define a workflow with some actions to build demo application and test the library. It will help us to ensure code on pull requests or being merged compiles and has all tests green. -This workflow is defined in [this YAML](https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/workflows/build-and-test.yml) +This workflow is defined in [this YAML](https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/workflows/build-and-test.yml), and makes build, unit tests and UI tests. Keep in mind we may have [some troubles with UI tests](https://github.com/Orange-OpenSource/ouds-ios/issues/305). -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). +We have also a *gitleaks* workflow making some scans on the code to look fo secrets leaks, defined in [this YAML](https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/workflows/gitleaks-action.yml). We use also two GitHub apps making controls on pull requests and defining wether or not prerequisites are filled or not. -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/). +There is one 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/). Finaly we have [this *GitHub Action*](https://github.com/cirruslabs/swiftlint-action) using _SwiftLint_ to ensure no warnings are in our codebase. ### GitLab CI (internal) We use *GitLab CI*for CI/CD with our own runners so as to keep private our sensitive files likes certificates and provisioning profiles. -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. +Our current 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. However of course you will have to define all the variables, secrets and have the mandatory files. -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). +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/51-%E2%80%90-About-continuous-integration-and-delivery). In few words, there is a pipeline containing some stages and jobs to build alpha, nightly/beta and production releases. diff --git a/OUDS/Core/OUDS/Sources/_OUDS.docc/GettingStarted.md b/OUDS/Core/OUDS/Sources/_OUDS.docc/GettingStarted.md index a1725e2f2..7d6b31bc7 100644 --- a/OUDS/Core/OUDS/Sources/_OUDS.docc/GettingStarted.md +++ b/OUDS/Core/OUDS/Sources/_OUDS.docc/GettingStarted.md @@ -12,7 +12,7 @@ If you want to add the iOS library of **Orange Unified Design System**, you need To do that, add a new _package dependency_ to your _Xcode_ project by refering to it with `https://github.com/Orange-OpenSource/ouds-ios`. You are free to choose wether or not you want a branch or a specific tag, pick the solution you want. -You can [refer to the wiki](https://github.com/Orange-OpenSource/ouds-ios/wiki/7-%E2%80%90-About-versions,-releases-and-builds) for more details about versions, releases and tags. +You can [refer to the wiki](https://github.com/Orange-OpenSource/ouds-ios/wiki/50-%E2%80%90-About-versions,-releases-and-builds) for more details about versions, releases and tags. ### Import the library you need diff --git a/OUDS/Core/OUDS/Sources/_OUDS.docc/Tokens.md b/OUDS/Core/OUDS/Sources/_OUDS.docc/Tokens.md index 36fcd2ee8..4329dffd3 100644 --- a/OUDS/Core/OUDS/Sources/_OUDS.docc/Tokens.md +++ b/OUDS/Core/OUDS/Sources/_OUDS.docc/Tokens.md @@ -141,7 +141,7 @@ You may need to [create an issue](https://github.com/Orange-OpenSource/ouds-ios/ ### For raw tokens -You can refer to the *OUDSTokensRaw* documentation or [get it online](https://ios.unified-design-system.orange.com/documentation/oudstokensraw/). [The wiki provides details](https://github.com/Orange-OpenSource/ouds-ios/wiki/0-%E2%80%90-How-to-update-tokens) also. +You can refer to the *OUDSTokensRaw* documentation or [get it online](https://ios.unified-design-system.orange.com/documentation/oudstokensraw/). [The wiki provides details](https://github.com/Orange-OpenSource/ouds-ios/wiki/20-%E2%80%90-How-to-update-tokens) also. ### For semantic tokens