Merge pull request #18 from d4l-data4life/feature/update-build-and-docs

Feature/update build and docs

.github/workflows/pr-archive.yml

@@ -35,5 +35,5 @@ jobs:
       run: xcrun simctl erase all
     - name: Test archive
       env:
-        VERSION: 0.0.0
-      run: bundle exec fastlane ios build_xcframework version:"$VERSION"
+        VERSION: v0.0.0
+      run: bundle exec fastlane ios build_utils version:"$VERSION"

CHANGELOG.adoc

@@ -0,0 +1,155 @@
+= Changelog
+:link-repository: https://github.com/d4l-data4life/d4l-utils-ios
+:doctype: article
+:toc: macro
+:toclevels: 1
+:toc-title:
+:icons: font
+:imagesdir: assets/images
+ifdef::env-github[]
+:warning-caption: :warning:
+:caution-caption: :fire:
+:important-caption: :exclamation:
+:note-caption: :paperclip:
+:tip-caption: :bulb:
+endif::[]
+
+All notable changes to this project will be documented in this file.
+
+The format is based on http://keepachangelog.com/en/1.0.0/[Keep a Changelog]
+and this project adheres to http://semver.org/spec/v2.0.0.html[Semantic Versioning].
+
+Template could be found here: link:https://github.com/d4l-data4life/hc-readme-template/blob/main/TEMPLATE_CHANGELOG.adoc[CHANGELOG]
+
+[discrete]
+==== Versions
+
+toc::[]
+
+== link:{link-repository}/releases/latest[Unreleased]
+
+See link:{link-repository}/compare/v0.7.0...main[changeset]
+
+=== Added
+
+=== Changed
+
+=== Removed
+
+=== Fixed
+
+=== Security
+
+=== Bumped
+
+=== Deprecated
+
+=== Migration
+
+
+== link:{link-repository}/releases/tag/v0.7.0[0.7.0]
+
+=== Bumped
+
+* Updated to xcode 13.1
+
+== link:{link-repository}/releases/tag/0.6.0[0.6.0]
+
+=== Removed
+
+* Removes debug symbols from xcframework due to duplicates issues
+
+== link:{link-repository}/releases/tag/0.5.0[0.5.0]
+
+=== Removed
+
+* Removes support for iOS 12
+* Removes CryptoSwift dependency
+
+== link:{link-repository}/releases/tag/0.4.0[0.4.0]
+
+=== Changed
+
+* Now distributing XCFramework instead of fat one
+* Discontinued Carthage in favor of Swift PM as decentralized
+* Adds separate Cryptoswift xcframework
+
+== link:{link-repository}/releases/tag/0.3.1[0.3.1]
+
+=== Changed
+
+* Pod spec updated to public repo
+
+== link:{link-repository}/releases/tag/0.3.0[0.3.0]
+
+=== Changed
+
+* Open sourced
+
+== link:{link-repository}/releases/tag/0.2.3[0.2.3]
+
+=== Added
+
+* Readded Carthage support using carthage CryptoSwift instead of the swiftPM version
+
+== link:{link-repository}/releases/tag/0.2.2[0.2.2]
+
+=== Added
+
+* Switch CryptoSwift repository to own fork to create dynamic library
+
+== link:{link-repository}/releases/tag/0.2.1[0.2.1]
+
+=== Added
+
+* Makes Swift Package dynamic
+
+== link:{link-repository}/releases/tag/0.2.0[0.2.0]
+
+=== Added
+
+* Adds Support for Swift PM
+* Adds CryptoSwift as package dependency instead
+* Removes Carthage need for building framework
+
+== link:{link-repository}/releases/tag/0.1.6[0.1.6]
+
+=== Added
+
+* Fixes framework embedding issue for app store
+
+== link:{link-repository}/releases/tag/0.1.5[0.1.5]
+
+=== Added
+
+* Adds Cocoapods support
+
+== link:{link-repository}/releases/tag/0.1.4[0.1.4]
+
+=== Added
+
+* Adds Data SHA1 algorithm
+
+== link:{link-repository}/releases/tag/0.1.3[0.1.3]
+=== Fixed
+* Fixes Data Validator SDK Limit
+
+== link:{link-repository}/releases/tag/0.1.2[0.1.2]
+
+=== Added
+
+* Adds Data Validator public properties
+
+== link:{link-repository}/releases/tag/0.1.1[0.1.1]
+
+=== Added
+
+* Adds Data Validator
+
+== link:{link-repository}/releases/tag/0.1.0[0.1.0]
+
+=== Added
+
+* First version of SDK Utils library
+
+

CODE-OF-CONDUCT.md → CODE-OF-CONDUCT.adoc

@@ -1,6 +1,25 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
+= Contributor Covenant Code of Conduct
+:link-repository: https://github.com/d4l-data4life/d4l-utils-ios
+:doctype: article
+:toc: macro
+:toclevels: 2
+:toc-title:
+:icons: font
+:imagesdir: assets/images
+ifdef::env-github[]
+:warning-caption: :warning:
+:caution-caption: :fire:
+:important-caption: :exclamation:
+:note-caption: :paperclip:
+:tip-caption: :bulb:
+endif::[]
+
+[discrete]
+==== Table Of Contents
+
+toc::[]
+
+== Our Pledge
 
 In the interest of fostering an open and welcoming environment, we as
 contributors and maintainers pledge to making participation in our project and
@@ -9,29 +28,29 @@ size, disability, ethnicity, gender identity and expression, level of experience
 nationality, personal appearance, race, religion, or sexual identity and
 orientation.
 
-## Our Standards
+== Our Standards
 
 Examples of behavior that contributes to creating a positive environment
 include:
 
-- Using welcoming and inclusive language
-- Being respectful of differing viewpoints and experiences
-- Gracefully accepting constructive criticism
-- Focusing on what is best for the community
-- Showing empathy towards other community members
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
 
 Examples of unacceptable behavior by participants include:
 
-- The use of sexualized language or imagery and unwelcome sexual attention or
-  advances
-- Trolling, insulting/derogatory comments, and personal or political attacks
-- Public or private harassment
-- Publishing others' private information, such as a physical or electronic
-  address, without explicit permission
-- Other conduct which could reasonably be considered inappropriate in a
-  professional setting
+* The use of sexualized language or imagery and unwelcome sexual attention or
+ advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+ address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+ professional setting
 
-## Our Responsibilities
+== Our Responsibilities
 
 Project maintainers are responsible for clarifying the standards of acceptable
 behavior and are expected to take appropriate and fair corrective action in
@@ -43,7 +62,7 @@ that are not aligned to this Code of Conduct, or to ban temporarily or
 permanently any contributor for other behaviors that they deem inappropriate,
 threatening, offensive, or harmful.
 
-## Scope
+== Scope
 
 This Code of Conduct applies both within project spaces and in public spaces
 when an individual is representing the project or its community. Examples of
@@ -52,10 +71,10 @@ address, posting via an official social media account, or acting as an appointed
 representative at an online or offline event. Representation of a project may be
 further defined and clarified by project maintainers.
 
-## Enforcement
+== Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at mobile@data4life.care. All
+reported by contacting the project team at mailto:mobile@data4life.care[mobile@data4life.care]. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -65,10 +84,7 @@ Project maintainers who do not follow or enforce the Code of Conduct in good
 faith may face temporary or permanent repercussions as determined by other
 members of the project's leadership.
 
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [https://contributor-covenant.org/version/1/4][version]
+== Attribution
 
-[homepage]: https://contributor-covenant.org
-[version]: https://contributor-covenant.org/version/1/4/
+This Code of Conduct is adapted from the link:https://contributor-covenant.org[Contributor Covenant], version 1.4,
+available at link:https://contributor-covenant.org/version/1/4/[https://contributor-covenant.org/version/1/4]