Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update images for circleci #1

Merged
merged 11 commits into from
Apr 5, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .autorc
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,10 @@
[
"cocoapods",
{
"podspecPath": "SwiftHooks.podspec"
"podspecPath": "SwiftHooks.podspec",
"flags": [
"--allow-warnings"
]
}
],
[
Expand Down
13 changes: 10 additions & 3 deletions .circleci/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ version: 2
jobs:
build:
docker:
- image: hborawski/swift-docc-docker:latest
- image: hborawski/swift-docc-docker:sha-fa2a2c1

steps:
- checkout
Expand Down Expand Up @@ -49,11 +49,18 @@ jobs:

release:
docker:
- image: hborawski/swift-docc-docker:latest
- image: hborawski/auto-container:sha-1bb9c32

steps:
- checkout
- run: ~/auto shipit -vvv --dry-run
- run:
name: Git Config
command: |
echo "https://$GITHUB_USER:$GH_TOKEN@github.intuit.com" >> /tmp/gitcredfile
git config --global user.name "$GITHUB_USER"
git config --global user.email "opensource-svc@intuit.com"
git config --global credential.helper "store --file=/tmp/gitcredfile"
- run: ~/auto shipit -vvv
workflows:
version: 2
build:
Expand Down
9 changes: 0 additions & 9 deletions Package.resolved
Original file line number Diff line number Diff line change
Expand Up @@ -10,15 +10,6 @@
"version": "0.2.1"
}
},
{
"package": "CryptoSwift",
"repositoryURL": "https://github.com/krzyzanowskim/CryptoSwift.git",
"state": {
"branch": null,
"revision": "5669f222e46c8134fb1f399c745fa6882b43532e",
"version": "1.3.8"
}
},
{
"package": "SourceKitten",
"repositoryURL": "https://github.com/jpsim/SourceKitten.git",
Expand Down
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
<div align="center">
<img
src="Sources/Hooks/Documentation.docc/Resources/Images/hooks@2x.png"
alt="Hooks Logo"
src="Sources/SwiftHooks/Documentation.docc/Resources/Images/hooks@2x.png"
alt="SwiftHooks Logo"
width="300px"
padding="40px"
/>
<br />
<br />
<p>Hooks is a little module for plugins, in Swift</p>
<p>SwiftHooks is a little module for plugins, in Swift</p>
</div>

---
Expand Down Expand Up @@ -46,13 +46,13 @@ let package = Package(
Install with [CocoaPods](https://cocoapods.org/) by adding an entry to your `Podfile`, and then running `pod install`:

```ruby
pod 'Hooks'
pod 'SwiftHooks'
```

## Structure

- [Hooks](https://github.com/intuit/swift-hooks/tree/main/Sources/Hooks) - The Hooks implementation
- [ExampleLibrary](https://github.com/intuit/swift-hooks/tree/main/Sources/ExampleLibrary) - An example usage of Hooks
- [SwiftHooks](https://github.com/intuit/swift-hooks/tree/main/Sources/SwiftHooks) - The SwiftHooks implementation
- [ExampleLibrary](https://github.com/intuit/swift-hooks/tree/main/Sources/ExampleLibrary) - An example usage of SwiftHooks

## Contributing

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
@Tutorial(time: 5) {
@Intro(title: "Key Concepts") {
Introduction to Hooks
Introduction to SwiftHooks

<!-- @Image(source: <#file#>, alt: "<#accessible description#>")-->
}
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
@Tutorial(time: 5) {
@Intro(title: "Plugin Architecture") {
Hooks can be used adhoc, and work well at it, the main use case is to enable a plugin architecture. Plugin architecture can be perceived as similar to the delegate patterns frequently used in iOS frameworks, such as UIKit.
SwiftHooks can be used adhoc, and work well at it, the main use case is to enable a plugin architecture. Plugin architecture can be perceived as similar to the delegate patterns frequently used in iOS frameworks, such as UIKit.

However, rather than having a single delegate for some given class, any number of plugins can tap hooks to supply functionality, or react to events in the lifecycle of the software calling the hooks.

Expand Down
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
# ``Hooks``
# ``SwiftHooks``

![Logo](hooks.png)

A little module for plugins, in swift.

## Overview
Hooks is a swift package for enabling plugins, based on [tapable](https://github.com/webpack/tapable) and [hooks](https://github.com/intuit/hooks/).
SwiftHooks is a swift package for enabling plugins, based on [tapable](https://github.com/webpack/tapable) and [hooks](https://github.com/intuit/hooks/).

A `Hook` represents a "pluggable" point in a software model. They provide a mechanism for "tapping" into such points to get updates, or apply additional functionality to some typed object.

Expand Down
14 changes: 7 additions & 7 deletions Sources/SwiftHooks/Documentation.docc/User Guide.tutorial
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
@Tutorials(name: "Hooks") {
@Tutorials(name: "SwiftHooks") {
@Intro(title: "User Guide") {
Learn how to use Hooks
Learn how to use SwiftHooks

<!-- @Image(source: <#file#>, alt: "<#accessible description#>")-->
}

@Volume(name: "Getting Started") {
What are Hooks, and how are they used?
What are SwiftHooks, and how are they used?
@Chapter(name: "Key Concepts") {
The basics and background of Hooks
The basics and background of SwiftHooks
<!-- @Image(source: <#file#>, alt: "<#accessible description#>")-->

@TutorialReference(tutorial: "doc:Key-Concepts")
Expand All @@ -25,13 +25,13 @@
@Volume(name: "Advanced Usage") {
Additional supported capabilities of hooks, for more complex use cases.
@Chapter(name: "Interceptors") {
Advanced usage of Hooks may see the need to intercept varying information about hooks, and what is tapping them.
Advanced usage of SwiftHooks may see the need to intercept varying information about hooks, and what is tapping them.
<!-- @Image(source: <#file#>, alt: "<#accessible description#>")-->

@TutorialReference(tutorial: "doc:Interceptors-Usage")
}
@Chapter(name: "Context") {
Advanced usage of Hooks may see the need to pass contextual information to taps in certain circumstances.
Advanced usage of SwiftHooks may see the need to pass contextual information to taps in certain circumstances.
<!-- @Image(source: <#file#>, alt: "<#accessible description#>")-->

@TutorialReference(tutorial: "doc:HookContextGuide")
Expand All @@ -43,7 +43,7 @@
@Documentation {
API Documentation

<doc:Hooks>
<doc:SwiftHooks>
}
}
}