Skip to content

Commit

Permalink
Merge pull request #455 from xmtp-labs/rygine/update-ci
Browse files Browse the repository at this point in the history
Update GitHub actions
  • Loading branch information
rygine authored Mar 1, 2024
2 parents 53a570c + 451a5fe commit ff76c16
Show file tree
Hide file tree
Showing 19 changed files with 222 additions and 113 deletions.
3 changes: 1 addition & 2 deletions .github/CODEOWNERS
Validating CODEOWNERS rules …
Original file line number Diff line number Diff line change
@@ -1,3 +1,2 @@
# Global rule:
* @xmtp-labs/web
*.md @jhaaaa
*.md @fabriguespe
30 changes: 0 additions & 30 deletions .github/ISSUE_TEMPLATE/bug_report.md

This file was deleted.

28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: Report a bug
description: Report a bug to share an issue you're experiencing.
title: "Bug: "
labels: bug
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to report a bug. Community contributions like yours are key to the development and adoption of XMTP. Review the following guidelines for reporting a bug:
- Include 1 bug per issue. Creating 1 issue per bug will make it easier to assign and track progress on bugs.
- Check [existing issues](https://github.com/xmtp-labs/xmtp-inbox-web/issues) to see if your issue has already been reported.
- Ensure that the bug is not security-related and can safely be disclosed publicly on GitHub. For information about how to report a security issue, see [Security policy](https://github.com/xmtp-labs/xmtp-inbox-web/security/policy).
- Follow the [XMTP code of conduct](https://github.com/xmtp-labs/xmtp-inbox-web/blob/main/CODE_OF_CONDUCT.md).
- type: textarea
id: bug-description
attributes:
label: Describe the bug
description: Provide a clear and concise description of the issue. Attach screenshots, if applicable.
- type: textarea
id: expected-behavior
attributes:
label: Expected behavior
description: Provide a clear and concise description of the behavior you expected. Attach screenshots, if applicable.
- type: textarea
id: reproduce
attributes:
label: Steps to reproduce the bug
description: Provide a clear and concise description of how to reproduce the bug, including any relevant environment details such as SDK version, browser, OS, and device.
5 changes: 5 additions & 0 deletions .github/ISSUE_TEMPLATE/config.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
blank_issues_enabled: false
contact_links:
- name: Have questions about how to build with XMTP?
url: https://community.xmtp.org/
about: Ask your question and learn with the community in the XMTP Community Forums.
19 changes: 0 additions & 19 deletions .github/ISSUE_TEMPLATE/feature_request.md

This file was deleted.

33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
name: Request a feature
description: Create a feature request to suggest an idea or enhancement.
title: "Feature request: "
labels: enhancement
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to request a feature. Community contributions like yours are key to the development and adoption of XMTP. Review the following guidelines for requesting a feature:
- Include 1 feature request per issue. Creating 1 issue per request will make it easier to explore and assign a priority to a request.
- Check [existing issues](https://github.com/xmtp-labs/xmtp-inbox-web/issues) to see if the feature has already been requested.
- Ensure that the feature is not security-related and can safely be disclosed publicly on GitHub. For information about how to report a security issue, see [Security policy](https://github.com/xmtp-labs/xmtp-inbox-web/security/policy).
- Follow the [XMTP code of conduct](https://github.com/xmtp-labs/xmtp-inbox-web/blob/main/CODE_OF_CONDUCT.md).
- type: textarea
id: problem-description
attributes:
label: Is your feature request related to a problem?
description: Provide a clear and concise description of the problem to be solved.
- type: textarea
id: solution
attributes:
label: Describe the solution to the problem
description: Provide a clear and concise description of what you want to happen to solve the problem.
- type: textarea
id: usecases
attributes:
label: Describe the uses cases for the feature
description: Provide a clear and concise description of the use cases the feature unlocks.
- type: textarea
id: details
attributes:
label: Additional details
description: Add any other details about your feature request. Attach screenshots, if applicable.
69 changes: 69 additions & 0 deletions .github/workflows/checks.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
name: Code Checks

on: [pull_request]

jobs:
format:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version-file: ".node-version"
cache: "npm"
- name: Install dependencies
run: npm ci
- name: Check code format
run: npm run format:check

lint:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version-file: ".node-version"
cache: "npm"
- name: Install dependencies
run: npm ci
- name: Lint
run: npm run lint

test:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version-file: ".node-version"
cache: "npm"
- name: Install dependencies
run: npm ci
- name: Run tests
run: npm run test

typecheck:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version-file: ".node-version"
cache: "npm"
- name: Install dependencies
run: npm ci
- name: Check types
run: npm run typecheck

build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version-file: ".node-version"
cache: "npm"
- name: Install dependencies
run: npm ci
- name: Build
run: npm run build
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,13 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- uses: actions/setup-node@v3
uses: actions/checkout@v4
- uses: actions/setup-node@v4
with:
node-version: 18.14.0
node-version-file: ".node-version"
cache: "npm"
# Install NPM dependencies, cache them correctly
# and run all Cypress tests
- name: Cypress run
uses: cypress-io/github-action@v5
uses: cypress-io/github-action@v6
with:
build: npm run build
start: npm run dev
Expand Down
17 changes: 0 additions & 17 deletions .github/workflows/fmt-check.yml

This file was deleted.

17 changes: 0 additions & 17 deletions .github/workflows/lint.yml

This file was deleted.

17 changes: 0 additions & 17 deletions .github/workflows/tests.yml

This file was deleted.

5 changes: 3 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,9 @@ composer.lock
*.swp
*.swo
.projectile
.vscode
.vscode/*
!.vscode/extensions.json
!.vscode/settings.json
.history
*.vsix
*.tmproj
Expand All @@ -58,5 +60,4 @@ dist

# Environment
.env*
!docker/.env.default

1 change: 1 addition & 0 deletions .node-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
18.19.1
1 change: 1 addition & 0 deletions .nvmrc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
18.19.1
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
/.reflame.config.jsonc
CODEOWNERS
7 changes: 6 additions & 1 deletion .vscode/extensions.json
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
{
"recommendations": ["reflame.agent"]
"recommendations": [
"reflame.agent",
"dbaeumer.vscode-eslint",
"esbenp.prettier-vscode",
"clinyong.vscode-css-modules"
]
}
25 changes: 25 additions & 0 deletions .vscode/settings.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
{
"editor.formatOnSave": true,
"editor.tabSize": 2,
"editor.codeActionsOnSave": {
"source.fixAll.eslint": "explicit"
},
"[typescript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[typescriptreact]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[javascript]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[jsonc]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[json]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
},
"[css]": {
"editor.defaultFormatter": "esbenp.prettier-vscode"
}
}
43 changes: 43 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# XMTP code of conduct

This code of conduct applies within all XMTP community spaces, virtual and physical, and also applies when an individual is officially representing the XMTP community in public spaces. Examples of representing our community include using an official email address, posting via an official social media account, or acting as an appointed representative at an online or offline event.

## Our pledge

We as members pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, or sexual identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.

## Our conduct

Examples of behaviors that contribute to a positive environment for our community include:

- Demonstrating empathy and kindness toward other people
- Being collaborative and respectful of differing opinions, viewpoints, and experiences. A great protocol is built by many contributors learning and working together.
- Being bold yet intentional when presenting ideas. We are here to help ensure the world has access to secure and private communication, while also acknowledging that building successful protocols and ecosystems requires the application of logic and evidence.
- Giving and gracefully accepting constructive feedback
- Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
- Focusing on what is best not just for us as individuals but for the overall community, and the people depending on XMTP for communication.

Examples of unacceptable behavior include:

- The use of sexualized language or imagery, and sexual attention or advances of any kind
- Hate speech, trolling, shitposting, flaming, spamming, unsolicited advertising, baiting, insulting or derogatory comments, and personal or political attacks
- Public or private harassment
- Publishing others’ private information, such as a physical or email address, without their explicit permission

## Moderation

Community moderators are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.

Community moderators have the right and responsibility to remove, edit, or reject comments, commits, code, issues, and other contributions that are not aligned to this code of conduct and will communicate reasons for moderation decisions when appropriate.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior can be reported to the community moderators responsible for enforcement at [[email protected]](mailto:[email protected]). All complaints will be reviewed and investigated and will result in a response that is deemed necessary and appropriate to the circumstances. All community moderators are obligated to respect the privacy and security of the reporter of any incident.

Community moderators who do not follow or enforce the code of conduct in good faith may face temporary or permanent repercussions as determined by other community moderators.

## Attribution

The XMTP code of conduct is adapted from the Contributor Covenant, [version 2.1](https://www.contributor-covenant.org/version/2/1/code_of_conduct.html) and [version 1.4](https://www.contributor-covenant.org/version/1/4/code-of-conduct.html).
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -21,8 +21,8 @@
"cypress": "cypress run",
"dev": "vite",
"e2e:headless": "start-server-and-test dev http://localhost:5173 cypress",
"fmt:check": "prettier -c --ignore-path .gitignore --ignore-path .prettierignore .",
"fmt:fix": "prettier -w --ignore-path .gitignore --ignore-path .prettierignore .",
"format": "prettier -w --ignore-path .gitignore --ignore-path .prettierignore .",
"format:check": "prettier -c --ignore-path .gitignore --ignore-path .prettierignore .",
"postinstall": "patch-package",
"lint": "eslint . --ignore-path .gitignore",
"preview": "vite preview",
Expand Down

0 comments on commit ff76c16

Please sign in to comment.