Skip to content

Commit ecb065a

Browse files
stephencelismbrandonw
stephencelis
and
mbrandonw
committed
Concurrency extras
Co-authored-by: Brandon Williams <[email protected]>
0 parents  commit ecb065a

28 files changed

+2078
-0
lines changed

‎.github/CODE_OF_CONDUCT.md

+132
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,132 @@
1+
# Contributor Covenant Code of Conduct
2+
3+
## Our Pledge
4+
5+
We as members, contributors, and leaders pledge to make participation in our
6+
community a harassment-free experience for everyone, regardless of age, body
7+
size, visible or invisible disability, ethnicity, sex characteristics, gender
8+
identity and expression, level of experience, education, socio-economic status,
9+
nationality, personal appearance, race, caste, color, religion, or sexual
10+
identity and orientation.
11+
12+
We pledge to act and interact in ways that contribute to an open, welcoming,
13+
diverse, inclusive, and healthy community.
14+
15+
## Our Standards
16+
17+
Examples of behavior that contributes to a positive environment for our
18+
community include:
19+
20+
* Demonstrating empathy and kindness toward other people
21+
* Being respectful of differing opinions, viewpoints, and experiences
22+
* Giving and gracefully accepting constructive feedback
23+
* Accepting responsibility and apologizing to those affected by our mistakes,
24+
and learning from the experience
25+
* Focusing on what is best not just for us as individuals, but for the overall
26+
community
27+
28+
Examples of unacceptable behavior include:
29+
30+
* The use of sexualized language or imagery, and sexual attention or advances of
31+
any kind
32+
* Trolling, insulting or derogatory comments, and personal or political attacks
33+
* Public or private harassment
34+
* Publishing others' private information, such as a physical or email address,
35+
without their explicit permission
36+
* Other conduct which could reasonably be considered inappropriate in a
37+
professional setting
38+
39+
## Enforcement Responsibilities
40+
41+
Community leaders are responsible for clarifying and enforcing our standards of
42+
acceptable behavior and will take appropriate and fair corrective action in
43+
response to any behavior that they deem inappropriate, threatening, offensive,
44+
or harmful.
45+
46+
Community leaders have the right and responsibility to remove, edit, or reject
47+
comments, commits, code, wiki edits, issues, and other contributions that are
48+
not aligned to this Code of Conduct, and will communicate reasons for moderation
49+
decisions when appropriate.
50+
51+
## Scope
52+
53+
This Code of Conduct applies within all community spaces, and also applies when
54+
an individual is officially representing the community in public spaces.
55+
Examples of representing our community include using an official e-mail address,
56+
posting via an official social media account, or acting as an appointed
57+
representative at an online or offline event.
58+
59+
## Enforcement
60+
61+
Instances of abusive, harassing, or otherwise unacceptable behavior may be
62+
reported to the community leaders responsible for enforcement at
63+
<[email protected]>.
64+
All complaints will be reviewed and investigated promptly and fairly.
65+
66+
All community leaders are obligated to respect the privacy and security of the
67+
reporter of any incident.
68+
69+
## Enforcement Guidelines
70+
71+
Community leaders will follow these Community Impact Guidelines in determining
72+
the consequences for any action they deem in violation of this Code of Conduct:
73+
74+
### 1. Correction
75+
76+
**Community Impact**: Use of inappropriate language or other behavior deemed
77+
unprofessional or unwelcome in the community.
78+
79+
**Consequence**: A private, written warning from community leaders, providing
80+
clarity around the nature of the violation and an explanation of why the
81+
behavior was inappropriate. A public apology may be requested.
82+
83+
### 2. Warning
84+
85+
**Community Impact**: A violation through a single incident or series of
86+
actions.
87+
88+
**Consequence**: A warning with consequences for continued behavior. No
89+
interaction with the people involved, including unsolicited interaction with
90+
those enforcing the Code of Conduct, for a specified period of time. This
91+
includes avoiding interactions in community spaces as well as external channels
92+
like social media. Violating these terms may lead to a temporary or permanent
93+
ban.
94+
95+
### 3. Temporary Ban
96+
97+
**Community Impact**: A serious violation of community standards, including
98+
sustained inappropriate behavior.
99+
100+
**Consequence**: A temporary ban from any sort of interaction or public
101+
communication with the community for a specified period of time. No public or
102+
private interaction with the people involved, including unsolicited interaction
103+
with those enforcing the Code of Conduct, is allowed during this period.
104+
Violating these terms may lead to a permanent ban.
105+
106+
### 4. Permanent Ban
107+
108+
**Community Impact**: Demonstrating a pattern of violation of community
109+
standards, including sustained inappropriate behavior, harassment of an
110+
individual, or aggression toward or disparagement of classes of individuals.
111+
112+
**Consequence**: A permanent ban from any sort of public interaction within the
113+
community.
114+
115+
## Attribution
116+
117+
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118+
version 2.1, available at
119+
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
120+
121+
Community Impact Guidelines were inspired by
122+
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
123+
124+
For answers to common questions about this code of conduct, see the FAQ at
125+
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
126+
[https://www.contributor-covenant.org/translations][translations].
127+
128+
[homepage]: https://www.contributor-covenant.org
129+
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
130+
[Mozilla CoC]: https://github.com/mozilla/diversity
131+
[FAQ]: https://www.contributor-covenant.org/faq
132+
[translations]: https://www.contributor-covenant.org/translations

‎.github/ISSUE_TEMPLATE/bug_report.yml

+71
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,71 @@
1+
name: Bug Report
2+
description: Something isn't working as expected
3+
labels: [bug]
4+
body:
5+
- type: markdown
6+
attributes:
7+
value: |
8+
Thank you for contributing to swift-concurrency-extras!
9+
10+
Before you submit your issue, please complete each text area below with the relevant details for your bug, and complete the steps in the checklist
11+
- type: textarea
12+
attributes:
13+
label: Description
14+
description: |
15+
A short description of the incorrect behavior.
16+
17+
If you think this issue has been recently introduced and did not occur in an earlier version, please note that. If possible, include the last version that the behavior was correct in addition to your current version.
18+
validations:
19+
required: true
20+
- type: checkboxes
21+
attributes:
22+
label: Checklist
23+
options:
24+
- label: If possible, I've reproduced the issue using the `main` branch of this package.
25+
required: false
26+
- label: This issue hasn't been addressed in an [existing GitHub issue](https://github.com/pointfreeco/swift-concurrency-extras/issues) or [discussion](https://github.com/pointfreeco/swift-concurrency-extras/discussions).
27+
required: true
28+
- type: textarea
29+
attributes:
30+
label: Expected behavior
31+
description: Describe what you expected to happen.
32+
validations:
33+
required: false
34+
- type: textarea
35+
attributes:
36+
label: Actual behavior
37+
description: Describe or copy/paste the behavior you observe.
38+
validations:
39+
required: false
40+
- type: textarea
41+
attributes:
42+
label: Steps to reproduce
43+
description: |
44+
Explanation of how to reproduce the incorrect behavior.
45+
46+
This could include an attached project or link to code that is exhibiting the issue, and/or a screen recording.
47+
placeholder: |
48+
1. ...
49+
validations:
50+
required: false
51+
- type: input
52+
attributes:
53+
label: swift-concurrency-extras version information
54+
description: The version of swift-concurrency-extras used to reproduce this issue.
55+
placeholder: "'0.1.0' for example, or a commit hash"
56+
- type: input
57+
attributes:
58+
label: Destination operating system
59+
description: The OS running swift-concurrency-extras.
60+
placeholder: "'iOS 16.4' for example"
61+
- type: input
62+
attributes:
63+
label: Xcode version information
64+
description: The version of Xcode used to reproduce this issue.
65+
placeholder: "The version displayed from 'Xcode 〉About Xcode'"
66+
- type: textarea
67+
attributes:
68+
label: Swift Compiler version information
69+
description: The version of Swift used to reproduce this issue.
70+
placeholder: Output from 'xcrun swiftc --version'
71+
render: shell

‎.github/ISSUE_TEMPLATE/config.yml

+15
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
blank_issues_enabled: false
2+
3+
contact_links:
4+
- name: Project Discussion
5+
url: https://github.com/pointfreeco/swift-concurrency-extras/discussions
6+
about: Library Q&A, ideas, and more
7+
- name: Documentation
8+
url: https://pointfreeco.github.io/swift-concurrency-extras/main/documentation/concurrencyextras/
9+
about: Read the documentation
10+
- name: Videos
11+
url: https://www.pointfree.co/collections/concurrency
12+
about: Watch videos to get a behind-the-scenes look at how this library was motivated and built
13+
- name: Slack
14+
url: https://www.pointfree.co/slack-invite
15+
about: Community chat

‎.github/workflows/ci.yml

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
pull_request:
8+
branches:
9+
- '*'
10+
workflow_dispatch:
11+
12+
concurrency:
13+
group: ci-${{ github.ref }}
14+
cancel-in-progress: true
15+
16+
jobs:
17+
library:
18+
runs-on: macos-13
19+
strategy:
20+
matrix:
21+
xcode: ['14.3.1']
22+
config: ['debug', 'release']
23+
steps:
24+
- uses: actions/checkout@v3
25+
- name: Select Xcode ${{ matrix.xcode }}
26+
run: sudo xcode-select -s /Applications/Xcode_${{ matrix.xcode }}.app
27+
- name: Run ${{ matrix.config }} tests
28+
run: CONFIG=${{ matrix.config }} make test
29+
30+
ubuntu-tests:
31+
strategy:
32+
matrix:
33+
os: [ubuntu-20.04]
34+
config: ['debug', 'release']
35+
36+
runs-on: ${{ matrix.os }}
37+
38+
steps:
39+
- uses: actions/checkout@v3
40+
- name: Build
41+
run: swift build
42+
- name: Run tests
43+
run: swift test -c ${{ matrix.config }}

‎.github/workflows/documentation.yml

+74
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,74 @@
1+
# Build and deploy DocC to GitHub pages. Based off of @karwa's work here:
2+
# https://github.com/karwa/swift-url/blob/main/.github/workflows/docs.yml
3+
name: Documentation
4+
5+
on:
6+
release:
7+
types:
8+
- published
9+
push:
10+
branches:
11+
- main
12+
workflow_dispatch:
13+
14+
concurrency:
15+
group: docs-${{ github.ref }}
16+
cancel-in-progress: true
17+
18+
jobs:
19+
build:
20+
runs-on: macos-13
21+
steps:
22+
- name: Select Xcode 14.3
23+
run: sudo xcode-select -s /Applications/Xcode_14.3.app
24+
25+
- name: Checkout Package
26+
uses: actions/checkout@v3
27+
with:
28+
fetch-depth: 0
29+
30+
- name: Checkout gh-pages Branch
31+
uses: actions/checkout@v3
32+
with:
33+
ref: gh-pages
34+
path: docs-out
35+
36+
- name: Build documentation
37+
run: >
38+
rm -rf docs-out/.git;
39+
rm -rf docs-out/main;
40+
git tag -l --sort=-v:refname | grep -e "\d\+\.\d\+.0" | tail -n +6 | xargs -I {} rm -rf {};
41+
42+
for tag in $(echo "main"; git tag -l --sort=-v:refname | grep -e "\d\+\.\d\+.0" | head -6);
43+
do
44+
if [ -d "docs-out/$tag/data/documentation/concurrencyextras" ]
45+
then
46+
echo "✅ Documentation for "$tag" already exists.";
47+
else
48+
echo "⏳ Generating documentation for ConcurrencyExtras @ "$tag" release.";
49+
rm -rf "docs-out/$tag";
50+
51+
git checkout .;
52+
git checkout "$tag";
53+
54+
swift package \
55+
--allow-writing-to-directory docs-out/"$tag" \
56+
generate-documentation \
57+
--target ConcurrencyExtras \
58+
--output-path docs-out/"$tag" \
59+
--transform-for-static-hosting \
60+
--hosting-base-path /swift-concurrency-extras/"$tag" \
61+
&& echo "✅ Documentation generated for ConcurrencyExtras @ "$tag" release." \
62+
|| echo "⚠️ Documentation skipped for ConcurrencyExtras @ "$tag".";
63+
fi;
64+
done
65+
66+
- name: Fix permissions
67+
run: 'sudo chown -R $USER docs-out'
68+
69+
- name: Publish documentation to GitHub Pages
70+
uses: JamesIves/[email protected]
71+
with:
72+
branch: gh-pages
73+
folder: docs-out
74+
single-commit: true

‎.github/workflows/format.yml

+31
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Format
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
8+
concurrency:
9+
group: format-${{ github.ref }}
10+
cancel-in-progress: true
11+
12+
jobs:
13+
swift_format:
14+
name: swift-format
15+
runs-on: macos-12
16+
steps:
17+
- uses: actions/checkout@v2
18+
- name: Xcode Select
19+
run: sudo xcode-select -s /Applications/Xcode_14.0.1.app
20+
- name: Tap
21+
run: brew tap pointfreeco/formulae
22+
- name: Install
23+
run: brew install Formulae/[email protected]
24+
- name: Format
25+
run: make format
26+
- uses: stefanzweifel/git-auto-commit-action@v4
27+
with:
28+
commit_message: Run swift-format
29+
branch: 'main'
30+
env:
31+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore

+6
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.DS_Store
2+
/.build
3+
/.swiftpm
4+
/Packages
5+
/*.xcodeproj
6+
xcuserdata/

‎ConcurrencyExtras.xcworkspace/contents.xcworkspacedata

+7
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎ConcurrencyExtras.xcworkspace/xcshareddata/IDEWorkspaceChecks.plist

+8
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
3+
<plist version="1.0">
4+
<dict>
5+
<key>IDEDidComputeMac32BitWarning</key>
6+
<true/>
7+
</dict>
8+
</plist>

0 commit comments

Comments
 (0)