Skip to content

Commit 4aba2e3

Browse files
committed
ci: remove periphery GitHub Actions workflow
Periphery is a nice tool but has some issues with numerous false positive cases. It needs also to compile projects for all targets. In GitHub Actions it failed sometimes to build for other OS than iOS and iPadOS. In addition it consumes time and budget, and because of false positive cases errors are accepted and lost in noise with warnings. This Periphery must be used locally to have a manuel check of the results while false positive cases remain. Signed-off-by: Pierre-Yves Lapersonne <[email protected]>
1 parent 1b6a75b commit 4aba2e3

File tree

4 files changed

+12
-77
lines changed

4 files changed

+12
-77
lines changed

.github/DEVELOP.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -603,16 +603,20 @@ To apply use, run in your project (e.g. once cloned):
603603
git config --local --add core.hooksPath .git-hooks
604604
```
605605

606+
*SwiftFormat* is not used in GitHub Actions CI/CD because sources should be formatted before beeing pushed, not after.
607+
606608
## Dead code
607609

608610
We use [Periphery](https://github.com/peripheryapp/periphery) to look for dead code and help developers to track it and remove it.
609-
This tool is run in CI/CD side and can be run localy using *Fastlane*:
611+
This tool should be run locally, for example using *Fastlane*:
610612

611613
And run:
612614
```shell
613615
bundle exec fastlane check_dead_code
614616
```
615617

618+
Because _Periphery_ has several issues about false positive, and needs to compile the project to look for symbols, this tool is not used anymore in CI/CD on GitHub Actions. Indeed we needed to allow errors and treat errors as warnings, so as manual check was still needed.
619+
616620
You can also in Xcode run from the *Periphery* scheme so as to make a scan.
617621

618622
> [!CAUTION]
@@ -676,12 +680,12 @@ We use *GitHub Actions* so as to define a workflow with some actions to build de
676680
It will help us to ensure code on pull requests or being merged compiles and has all tests green.
677681

678682
Workflows are the following:
679-
- [build-and-test](https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/workflows/build-and-test.yml) to build and run unit tests
680-
- [gitleaks](https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/workflows/gitleaks.yml) to check if there are secrets leaks
681-
- [periphery](https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/workflows/periphery.yml) to check if there is dead code
682-
- [scorecard](https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/workflows/scorecard.yml) to buold the OpenSSF score card on README
683-
- [swiftlint](https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/workflows/swiftlint.yml) to check if there is no linter warnings
684-
- [swiftpolyglot](https://github.com/Orange-OpenSource/ouds-ios/blob/develop/.github/workflows/swiftpolyglot.yml) to check if there are localizations troubles
683+
- [build-and-test](https://github.com/Orange-OpenSource/ouds-ios-design-system-toolbox/blob/develop/.github/workflows/build-and-test.yml) to build and run unit tests
684+
- [dependency-review](https://github.com/Orange-OpenSource/ouds-ios-design-system-toolbox/blob/develop/.github/workflows/dependency-review.yml) to scan dependency manifest files surfacing known-vulnerable versions of the packages declared or updated in pull requests
685+
- [gitleaks](https://github.com/Orange-OpenSource/ouds-ios-design-system-toolbox/blob/develop/.github/workflows/gitleaks.yml) to check if there are secrets leaks
686+
- [scorecard](https://github.com/Orange-OpenSource/ouds-ios-design-system-toolbox/blob/develop/.github/workflows/scorecard.yml) to build the OpenSSF score card on README
687+
- [swiftlint](https://github.com/Orange-OpenSource/ouds-ios-design-system-toolbox/blob/develop/.github/workflows/swiftlint.yml) to check if there is no linter warnings
688+
- [swiftpolyglot](https://github.com/Orange-OpenSource/ouds-ios-design-system-toolbox/blob/develop/.github/workflows/swiftpolyglot.yml) to check if there are localizations troubles
685689

686690
We use also two GitHub apps making controls on pull requests and defining wether or not prerequisites are filled or not.
687691
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/).

.github/workflows/periphery.yml

Lines changed: 0 additions & 67 deletions
This file was deleted.

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,8 +19,6 @@
1919
&nbsp;
2020
<a href="https://github.com/Orange-OpenSource/ouds-ios-design-system-toolbox/actions/workflows/swiftpolyglot.yml" title="SwiftPolyglot status"><img src="https://github.com/Orange-OpenSource/ouds-ios-design-system-toolbox/actions/workflows/swiftpolyglot.yml/badge.svg" alt="SwiftPolyglot status"></a>
2121
&nbsp;
22-
<a href="https://github.com/Orange-OpenSource/ouds-ios-design-system-toolbox/actions/workflows/periphery.yml" title="Periphery status"><img src="https://github.com/Orange-OpenSource/ouds-ios-design-system-toolbox/actions/workflows/periphery.yml/badge.svg" alt="Periphery status"></a>
23-
&nbsp;
2422
<a href="https://github.com/Orange-OpenSource/ouds-ios-design-system-toolbox/actions/workflows/swiftlint.yml" title="SwiftLint status"><img src="https://github.com/Orange-OpenSource/ouds-ios-design-system-toolbox/actions/workflows/swiftlint.yml/badge.svg" alt="SwiftLint status"></a>
2523
&nbsp;
2624
<a href="https://scorecard.dev/viewer/?uri=github.com/Orange-OpenSource/ouds-ios-design-system-toolbox" title="OpenSSF Scorecard"><img src="https://api.scorecard.dev/projects/github.com/Orange-OpenSource/ouds-ios-design-system-toolbox/badge" alt="OpenSSF Scorecard"></a>

THIRD_PARTY.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ You may download the source code on the [following website](https://github.com/g
111111
You may download the source code on the [following website](https://github.com/anchore/grype).
112112

113113
#### Periphery
114-
<!-- Xcode target -->
114+
<!-- (CI/CD, tools, etc.) -->
115115

116116
Copyright (c) 2019 Ian Leitch
117117

0 commit comments

Comments
 (0)