This project describes the continuous integration and delivery processes using github workflow on forms
and formatters
.
These processes provide quality and timesaving advantages in software deployment.
- Github workflow files must be added under
.github/workflows
folder into your form root folder. - Swift package configuration file must be added into your form root folder to test yourself. (if not default one will be used)
- Tools configuration files *.yml could be added into your form root folder (if not default one will be used).
đź’ˇ Open the terminal, go to your form root folder and launch this command line to automatically download it.
curl -fsSL https://raw.githubusercontent.com/4d-for-ios/check-workflow/master/form/scripts/check_files.sh | bash -s
âś… Check Workflow
To ensure code quality, two types of tools are executed on code: linter to lint and compiler to build.
lint or linters are tools that can be used to check source code and flag programming errors, bugs, stylistic errors, and suspicious constructs.
We use swiftlint to lint source code.
A configuration file could be integrated .swiftlint.yml in the form root folder to specify the location of the source file.
đź’ˇ Then, simply run swiftlint
at project root to check by yourself.
We use iblinter to lint storyboards
A configuration file could be integrated .iblinter.yml in the form root folder to specify the location of the source file.
đź’ˇ Then, simply run iblinter
at project root to check by yourself.
We use jsonlint but any JSON linter can do the trick.
Build step uses swift build
on iOS to make sure that there are no build errors in the code.
The dependencies are defined in Package.swift
, in particular the 4d-for-ios sdk (mock).
đź’ˇ You must be connected on github to read the check log.
🚀 Release Workflow
This workflow helps you provide a bundled archive of your extension, so that you can share it.
When you create a new release on github, the bundled archive is automatically attached to the release.
- Github workflow files must be added under the
.github/workflows
folder into your form root folder.
đź’ˇ Open the terminal, go to your formatter root folder and launch this command line to automatically download it.
curl -fsSL https://raw.githubusercontent.com/4d-for-ios/check-workflow/master/formatter/scripts/check_files.sh | bash -s
Badge(image) could be added to the project readme file or in any markdown or html files to display continuous integration results.
[![:repo](https://github.com/:user/:repo/workflows/check/badge.svg)](https://github.com/:user/:repo/actions?workflow=check)
A badge with release version and download link could also be added using a service like https://shields.io/
[![release](https://img.shields.io/github/v/release/:user/:repo)](https://github.com/:user/:repo/releases/latest/download/:repo.zip)|
You can find an automatically-generated list in topic-workflow
Repository | Workflow | Download |
---|---|---|
4d-for-ios/form-login-SignInWithApple |