Skip to content

Commit 3a953b8

Browse files
scothisscothis
committed
initial commit
Signed-off-by: Scott Andrews <scott@andrews.me>
0 parents  commit 3a953b8

File tree

27 files changed

+1807
-0
lines changed

27 files changed

+1807
-0
lines changed

‎.github/workflows/ci.yaml‎

Lines changed: 90 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,90 @@
1+
name: CI
2+
3+
on:
4+
push:
5+
branches:
6+
- main
7+
tags:
8+
- 'v[0-9]+\.[0-9]+\.[0-9]+-?**'
9+
pull_request: {}
10+
11+
jobs:
12+
build:
13+
runs-on: ubuntu-latest
14+
steps:
15+
- uses: actions/checkout@v4
16+
- uses: actions-rust-lang/setup-rust-toolchain@v1
17+
with:
18+
toolchain: 1.84.1
19+
components: rustfmt
20+
target: wasm32-unknown-unknown,wasm32-wasip2
21+
- name: Install cargo binstall
22+
uses: cargo-bins/cargo-binstall@main
23+
- name: Install cargo component
24+
run: cargo binstall --force cargo-component
25+
- name: Install wkg
26+
run: cargo binstall --force wkg
27+
- name: Fetch wit
28+
run: make wit
29+
- name: Check for drift in generated wit
30+
run: git diff --exit-code .
31+
- name: Build components
32+
run: make components
33+
- name: Collect components.tar
34+
run: tar -cvf ../components.tar *.wasm*
35+
working-directory: ./lib
36+
- name: Upload components.tar
37+
uses: actions/upload-artifact@v4
38+
with:
39+
name: components.tar
40+
path: components.tar
41+
retention-days: 7
42+
43+
publish:
44+
if: startsWith(github.ref, 'refs/tags/')
45+
needs:
46+
- build
47+
permissions:
48+
contents: write
49+
packages: write
50+
runs-on: ubuntu-latest
51+
steps:
52+
- uses: actions/checkout@v4
53+
- uses: actions-rust-lang/setup-rust-toolchain@v1
54+
with:
55+
toolchain: 1.84.1
56+
components: rustfmt
57+
target: wasm32-unknown-unknown
58+
- name: Install cargo binstall
59+
uses: cargo-bins/cargo-binstall@main
60+
- name: Install wkg
61+
run: cargo binstall --force wkg
62+
- name: Get the version
63+
id: get_version
64+
run: echo ::set-output name=VERSION::${GITHUB_REF/refs\/tags\//}
65+
- name: Download components.tar
66+
uses: actions/download-artifact@v4
67+
with:
68+
name: components.tar
69+
- name: Extract components
70+
run: tar -xvf components.tar -C lib
71+
- name: Login to GitHub Container Registry
72+
uses: docker/login-action@v3
73+
with:
74+
registry: ghcr.io
75+
username: ${{ github.actor }}
76+
password: ${{ secrets.GITHUB_TOKEN }}
77+
- name: Publish components to gchr.io
78+
run: make publish
79+
env:
80+
REPOSITORY: "ghcr.io/${{ github.repository }}"
81+
VERSION: "${{ steps.get_version.outputs.VERSION }}"
82+
- name: Draft GitHub Release
83+
uses: softprops/action-gh-release@v2
84+
with:
85+
draft: true
86+
files: |
87+
lib/*.wasm
88+
components.tar
89+
fail_on_unmatched_files: true
90+
token: ${{ secrets.GITHUB_TOKEN }}

‎.gitignore‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
/components.tar
2+
/target
3+
.DS_Store

‎CODE_OF_CONDUCT.md‎

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

‎CONTRIBUTING.md‎

Lines changed: 75 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
2+
3+
# Contributing to Componentized
4+
5+
The Componentized project team welcomes contributions from the community. A contributor license agreement (CLA) is not required. You own full rights to your contribution and agree to license the work to the community under the Apache License v2.0, via a [Developer Certificate of Origin (DCO)](https://developercertificate.org).
6+
7+
## Contribution Flow
8+
9+
This is a rough outline of what a contributor's workflow looks like:
10+
11+
- Create a topic branch from where you want to base your work
12+
- Make commits of logical units
13+
- Make sure your commit messages are in the proper format (see below)
14+
- Push your changes to a topic branch in your fork of the repository
15+
- Submit a pull request
16+
17+
Example:
18+
19+
``` shell
20+
git remote add upstream https://github.com/componentized/filesystem.git
21+
git checkout -b my-new-feature main
22+
git commit -s -a
23+
git push origin my-new-feature
24+
```
25+
26+
### Staying In Sync With Upstream
27+
28+
When your branch gets out of sync with the upstream/main branch, use the following to update:
29+
30+
``` shell
31+
git checkout my-new-feature
32+
git fetch -a
33+
git pull --rebase upstream main
34+
git push --force-with-lease origin my-new-feature
35+
```
36+
37+
### Updating pull requests
38+
39+
If your PR fails to pass CI or needs changes based on code review, you'll most likely want to squash these changes into
40+
existing commits.
41+
42+
If your pull request contains a single commit or your changes are related to the most recent commit, you can simply
43+
amend the commit.
44+
45+
``` shell
46+
git add .
47+
git commit --amend
48+
git push --force-with-lease origin my-new-feature
49+
```
50+
51+
If you need to squash changes into an earlier commit, you can use:
52+
53+
``` shell
54+
git add .
55+
git commit --fixup <commit>
56+
git rebase -i --autosquash main
57+
git push --force-with-lease origin my-new-feature
58+
```
59+
60+
Be sure to add a comment to the PR indicating your new changes are ready to review, as GitHub does not generate a
61+
notification when you git push.
62+
63+
### Code Style
64+
65+
### Formatting Commit Messages
66+
67+
We follow the conventions on [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/).
68+
69+
Be sure to include any related GitHub issue references in the commit message. See
70+
[GFM syntax](https://guides.github.com/features/mastering-markdown/#GitHub-flavored-markdown) for referencing issues
71+
and commits.
72+
73+
## Reporting Bugs and Creating Issues
74+
75+
When opening a new issue, try to roughly follow the commit message format conventions above.

0 commit comments

Comments
 (0)