[UPDATE] added setup files

Author: SahilSainiYML

.github/workflows/run_jazzy.yml

@@ -0,0 +1,29 @@
+# This is a basic workflow to help you get started with Actions
+
+name: Run Jazzy
+
+# Controls when the workflow will run
+on:
+ # Triggers the workflow on push events but only for the main branch
+ push:
+ branches: [ main ]
+
+ # Allows you to run this workflow manually from the Actions tab
+ workflow_dispatch:
+
+# A workflow run is made up of one or more jobs that can run sequentially or in parallel
+jobs:
+ # This workflow contains a single job called "deploy_docs"
+ deploy_docs:
+ # The type of runner that the job will run on
+ runs-on: macos-12
+ 
+ # Steps represent a sequence of tasks that will be executed as part of the job
+ steps:
+ # Checks-out your repository under $GITHUB_WORKSPACE, so your job can access it
+ - uses: actions/checkout@v1
+ - name: Publish Jazzy Docs
+ uses: steven0351/publish-jazzy-docs@v1
+ with:
+ personal_access_token: ${{ secrets.ACCESS_TOKEN }}
+ config: .jazzy.yaml

.github/workflows/run_linter_and_unit_tests.yml

@@ -0,0 +1,34 @@
+name: Run linter and unit tests
+
+on:
+ push:
+ branches: [ "main" ]
+ pull_request:
+ branches: [ "main" ]
+ 
+ # Allows you to run this workflow manually from the Actions tab
+ workflow_dispatch:
+ 
+jobs:
+ build:
+
+ runs-on: macos-12
+
+ steps:
+ - uses: actions/checkout@v3
+ 
+ - name: Set Xcode version
+ run: |
+ ls -l /Applications | grep 'Xcode'
+ sudo xcode-select -s /Applications/Xcode_14.0.1.app
+
+ - name: Lint code using SwiftLint
+ run: swiftlint --strict --reporter github-actions-logging
+
+ - name: Build iOS
+ run: |
+ xcodebuild -scheme YStepper -sdk iphonesimulator16.0 -destination 'platform=iOS Simulator,name=iPhone 14' build-for-testing
+ 
+ - name: Run tests iOS
+ run: |
+ xcodebuild -scheme YStepper -sdk iphonesimulator16.0 -destination 'platform=iOS Simulator,name=iPhone 14' test-without-building

.gitignore

@@ -1,26 +1,19 @@
+# Generated by MacOS
+.DS_Store
+
 # Xcode
 #
 # gitignore contributors: remember to update Global/Xcode.gitignore, Objective-C.gitignore & Swift.gitignore
 
 ## User settings
-xcuserdata/
-
-## compatibility with Xcode 8 and earlier (ignoring not required starting Xcode 9)
-*.xcscmblueprint
-*.xccheckout
-
-## compatibility with Xcode 3 and earlier (ignoring not required starting Xcode 4)
-build/
-DerivedData/
-*.moved-aside
-*.pbxuser
-!default.pbxuser
-*.mode1v3
-!default.mode1v3
-*.mode2v3
-!default.mode2v3
-*.perspectivev3
-!default.perspectivev3
+*.xcuserstate
+*.xcuserdatad
+*.xcuserdata
+xcschememanagement.plist
+*/xcuserdata/*
+*.xcbkptlist
+*.xcworkspacedata
+IDEWorkspaceChecks.plist
 
 ## Obj-C/Swift specific
 *.hmap
@@ -39,7 +32,7 @@ playground.xcworkspace
 # Add this line if you want to avoid checking in source code from Swift Package Manager dependencies.
 # Packages/
 # Package.pins
-# Package.resolved
+Package.resolved
 # *.xcodeproj
 #
 # Xcode automatically generates this directory with a .xcworkspacedata file and xcuserdata
@@ -54,7 +47,7 @@ playground.xcworkspace
 # you should judge for yourself, the pros and cons are mentioned at:
 # https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
 #
-# Pods/
+*/Pods/*
 #
 # Add this line if you want to avoid checking in source code from the Xcode workspace
 # *.xcworkspace
@@ -88,3 +81,6 @@ fastlane/test_output
 # https://github.com/johnno1962/injectionforxcode
 
 iOSInjectionProject/
+
+## Docs
+/docs

.jazzy.yaml

@@ -0,0 +1,16 @@
+author: 'Y Media Labs'
+author_url: https://yml.co
+min_acl: public
+hide_documentation_coverage: false
+theme: fullwidth
+output: ./docs
+documentation: ./*.md
+swift_build_tool: xcodebuild
+module: YStepper
+xcodebuild_arguments:
+ - -scheme
+ - YStepper
+ - -sdk
+ - iphonesimulator
+ - -destination
+ - 'platform=iOS Simulator,name=iPhone 13'

.spi.yml

@@ -0,0 +1,3 @@
+version: 1
+external_links:
+ documentation: "https://yml-org.github.io/ystepper-ios/"

.swiftlint.yml

@@ -0,0 +1,43 @@
+# By default, SwiftLint uses a set of sensible default rules you can adjust:
+disabled_rules: # rule identifiers turned on by default to exclude from running
+
+ - multiple_closures_with_trailing_closure
+
+opt_in_rules: # some rules are turned off by default, so you need to opt-in
+ - contains_over_first_not_nil
+ - empty_count
+ - first_where
+ - force_unwrapping
+ - implicit_return
+ - missing_docs
+ - multiline_arguments
+ - multiline_arguments_brackets
+ - multiline_function_chains
+ - multiline_literal_brackets
+ - multiline_parameters
+ - multiline_parameters_brackets
+ - operator_whitespace
+ - prohibited_interface_builder
+ - unneeded_parentheses_in_closure_argument
+ - vertical_whitespace_closing_braces
+ - vertical_whitespace_opening_braces
+
+excluded: # paths to ignore during linting. Takes precedence over `included`.
+ - Pods
+ - docs
+ - .build
+
+# configurable rules can be customized from this configuration file
+# binary rules can set their severity level
+
+cyclomatic_complexity:
+ ignores_case_statements: true
+ 
+identifier_name:
+ min_length: 1
+
+trailing_whitespace:
+ ignores_empty_lines: true
+
+function_parameter_count:
+ warning: 6

PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,39 @@
+## Introduction ##
+
+In layman's terms, provide a brief introduction to the issue. No more than 3 sentences.
+
+## Purpose ##
+
+Explain the purpose of this pull request. Include a link to the issue being addressed.
+
+## Scope ##
+
+Detail the scope of the pull request, i.e. what changed.
+
+// Optional sections
+
+## Discussion ##
+
+Any discussion about approach, challenges, etc. that you feel is relevant.
+
+## Out of Scope ##
+
+Call out any known issues that are purposely not addressed in this pull request.
+
+## 📱 Screenshots ##
+
+For UI work, please include before/after screenshots hosted in a 2-column table for easy side-by-side comparison.
+
+## 🎬 Video ##
+
+Same as Screenshots above.
+
+## 📈 Coverage ##
+
+##### Code #####
+
+Include a snapshot of the Code Coverage report generated when you ran the full unit test suite.
+
+##### Documentation #####
+
+Include a snapshot of the documentation coverage report when you ran jazzy locally to generate documentation. We require 100% documentation coverage of all `public` interfaces.

README.md

@@ -1 +1,119 @@
-# ystepper-ios
+_Accessible and customizable Stepper user interface elements for iOS._
+
+Licensing
+----------
+Y—Stepper is licensed under the [Apache 2.0 license](LICENSE).
+
+Documentation
+----------
+
+Documentation is automatically generated from source code comments and rendered as a static website hosted via GitHub Pages at: https://yml-org.github.io/ystepper-ios/
+
+Usage
+----------
+
+Installation
+----------
+
+You can add Y—Stepper to an Xcode project by adding it as a package dependency.
+
+1. From the **File** menu, select **Add Packages...**
+2. Enter "[https://github.com/yml-org/ystepper-ios](https://github.com/yml-org/ystepper-ios)" into the package repository URL text field
+3. Click **Add Package**
+
+Contributing to Y—Stepper
+----------
+
+### Requirements
+
+#### SwiftLint (linter)
+```
+brew install swiftlint
+```
+
+#### Jazzy (documentation)
+```
+sudo gem install jazzy
+```
+
+### Setup
+
+Clone the repo and open `Package.swift` in Xcode.
+
+### Versioning strategy
+
+We utilize [semantic versioning](https://semver.org).
+
+```
+{major}.{minor}.{patch}
+```
+
+e.g.
+
+```
+1.0.5
+```
+
+### Branching strategy
+
+We utilize a simplified branching strategy for our frameworks.
+
+* main (and development) branch is `main`
+* both feature (and bugfix) branches branch off of `main`
+* feature (and bugfix) branches are merged back into `main` as they are completed and approved.
+* `main` gets tagged with an updated version # for each release
+ 
+### Branch naming conventions:
+
+```
+feature/{ticket-number}-{short-description}
+bugfix/{ticket-number}-{short-description}
+```
+e.g.
+```
+feature/CM-44-button
+bugfix/CM-236-textview-color
+```
+
+### Pull Requests
+
+Prior to submitting a pull request you should:
+
+1. Compile and ensure there are no warnings and no errors.
+2. Run all unit tests and confirm that everything passes.
+3. Check unit test coverage and confirm that all new / modified code is fully covered.
+4. Run `swiftlint` from the command line and confirm that there are no violations.
+5. Run `jazzy` from the command line and confirm that you have 100% documentation coverage.
+6. Consider using `git rebase -i HEAD~{commit-count}` to squash your last {commit-count} commits together into functional chunks.
+7. If HEAD of the parent branch (typically `main`) has been updated since you created your branch, use `git rebase main` to rebase your branch.
+ * _Never_ merge the parent branch into your branch.
+ * _Always_ rebase your branch off of the parent branch.
+
+When submitting a pull request:
+
+* Use the [provided pull request template](PULL_REQUEST_TEMPLATE.md) and populate the Introduction, Purpose, and Scope fields at a minimum.
+* If you're submitting before and after screenshots, movies, or GIF's, enter them in a two-column table so that they can be viewed side-by-side.
+
+When merging a pull request:
+
+* Make sure the branch is rebased (not merged) off of the latest HEAD from the parent branch. This keeps our git history easy to read and understand.
+* Make sure the branch is deleted upon merge (should be automatic).
+
+### Releasing new versions
+* Tag the corresponding commit with the new version (e.g. `1.0.5`)
+* Push the local tag to remote
+
+Generating Documentation (via Jazzy)
+----------
+
+You can generate your own local set of documentation directly from the source code using the following command from Terminal:
+```
+jazzy
+```
+This generates a set of documentation under `/docs`. The default configuration is set in the default config file `.jazzy.yaml` file.
+
+To view additional documentation options type:
+```
+jazzy --help
+```
+A GitHub Action automatically runs each time a commit is pushed to `main` that runs Jazzy to generate the documentation for our GitHub page at: https://yml-org.github.io/ystepper-ios/