Skip to content
Open
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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
17 changes: 17 additions & 0 deletions .eslintrc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
{
"parser": "@babel/eslint-parser",
"parserOptions": {
"ecmaVersion": 2021,
"sourceType": "module",
"requireConfigFile": false
},
"extends": ["plugin:@docusaurus/recommended", "plugin:@typescript-eslint/recommended"],
"plugins": ["@docusaurus", "@typescript-eslint"],
"rules": {
"@docusaurus/string-literal-i18n-messages": "error",
"@docusaurus/no-html-links": "error",
"@typescript-eslint/no-explicit-any": ["error", {"ignoreRestArgs": true}]
// Add other TypeScript rules as needed
},
"ignorePatterns": ["node_modules/", "build/"]
}
53 changes: 53 additions & 0 deletions .github/ISSUE_TEMPLATE/bug-report.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
name: Bug report
description: Create a bug report to help us improve Tailcall
title: "[bug]: "
labels: [bug]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to fill out this bug report.
- type: checkboxes
attributes:
label: Is there an existing issue for this?
description: Please search to see if an issue already exists for the bug you encountered
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Current behavior
description: A concise description of what you're experiencing and what you expect
placeholder: |
When I do <X>, <Y> happens and I see the error message attached below:
```...```
What I expect is <Z>
validations:
required: true
- type: textarea
attributes:
label: Steps to reproduce
description: Add steps to reproduce this behaviour, include console or network logs and screenshots
placeholder: |
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
validations:
required: true

- type: dropdown
id: repository
attributes:
label: Repository
options:
- tailcall
- tailcallhq.github.io
- homebrew-tailcall
- tailcall-on-aws
validations:
required: true
- type: markdown
attributes:
value: |
Please add the respective Label to the Issue
32 changes: 32 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation-update.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Documentation Update📄
description: Suggest an improvement/addition in the Tailcall Server Docs.
title: "[docs]: "
labels: [Documentation]

body:
- type: markdown
attributes:
value: Thank you for taking the time to file a Documentation tools.
- type: textarea
attributes:
label: What do you want to add to the docs? (please state reasons if any)
description: "Copy and paste the text currently in the documentation. If you want to improve graphs or photos, please provide a screenshot of the original."
- type: textarea
attributes:
label: Where is this stated?
description: "Please explain why the statement needs to be updated. This can be because it is confusing, incorrect, spelling/grammatical errors, etc."
- type: dropdown
id: repository
attributes:
label: Repository
options:
- tailcall
- tailcallhq.github.io
- homebrew-tailcall
- tailcall-on-aws
validations:
required: true
- type: markdown
attributes:
value: |
Please add the respective Label to the Issue
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/feature-request.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: Feature request
description: Suggest a feature to improve Tailcall
title: "[feature]: "
labels: [Enhancement]
body:
- type: markdown
attributes:
value: |
Thank you for taking the time to request a feature for Tailcall
- type: checkboxes
attributes:
label: Is there an existing feature request for this?
description: Please search to see if an issue related to this feature request/feature request already exists
options:
- label: I have searched the existing issues
required: true
- type: textarea
attributes:
label: Summary
description: One paragraph description of the feature
validations:
required: true
- type: textarea
attributes:
label: Why should this be worked on?
description: A concise description of the problems or use cases for this feature request
validations:
required: true
- type: dropdown
id: repository
attributes:
label: Repository
options:
- tailcall
- tailcallhq.github.io
- homebrew-tailcall
- tailcall-on-aws
validations:
required: true
- type: markdown
attributes:
value: |
Please add the respective Label to the Issue
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/write-a-guide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Write a Guide
about: Template to write guides
title: "doc: "
labels: ""
assignees: ""
---

<!-- Describe the requirements here -->

## Content Creation Requirements

To maintain the quality of our content, please adhere to the following guidelines:

### 1. Accuracy in Language

- **Grammar and Spelling:** Ensure your content is free from grammatical and spelling errors.

### 2. Tone and Style

- **Neutral Tone:** Maintain a neutral, non-emotional tone throughout the content.
- **Engaging Style:** Write in a free-flowing and engaging manner, keeping the reader's interest.

### 3. Content Integrity

- **Fact-Checking:** Verify all information. If unsure, use Discord to clarify.
- **Relevance:** Ensure all content is cohesive, to the point, and directly related to the title.

### 4. Originality

- **Avoid Low-Effort Content:** Content should be original and not solely generated by AI tools like ChatGPT.

**PS: Adherence to these guidelines is crucial. Content not meeting these standards may require revision or may not be accepted.**
3 changes: 3 additions & 0 deletions .github/codespell-ignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
crate
unit
currentY
43 changes: 43 additions & 0 deletions .github/workflows/ci.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
name: CI

on:
repository_dispatch:
types: build-and-deploy
push:
branches:
- "**"
pull_request:
branches: [develop]
types: [opened, reopened, synchronize]

permissions:
contents: write

jobs:
build-and-deploy:
concurrency: ci-${{ github.ref }}
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Check spelling
uses: codespell-project/actions-codespell@v2
with:
ignore_words_file: .github/codespell-ignore
skip: .git,**/*.png,**/*.gif,**/*.jpg,**/*.svg,**/*.ico,**/*.json,package.json,package-lock.json,*.lock,*.excalidraw,*.graphql,./blog-publisher/generated/graphql.ts,./releases/**/*.mdx

- name: Install Build & Test 🔧
run: |
npm install
npx prettier --check "**/*.{graphql,yml,json,md,sh,ts,tsx,js,css}"
npm run build
npm run test:cypress

- name: Deploy 🚀
if: github.ref == 'refs/heads/develop'
uses: JamesIves/github-pages-deploy-action@v4
with:
folder: build
30 changes: 30 additions & 0 deletions .github/workflows/convention.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
name: PR Title Validation

on:
# pull_request_target is ok until we do not checkout and build external code
# TODO: maybe it is not required after all https://github.com/amannn/action-semantic-pull-request/issues/219
pull_request_target:
types: [opened, reopened, synchronize, edited]

permissions:
pull-requests: read

jobs:
title-check:
name: Check PR Title
runs-on: ubuntu-latest

steps:
- name: PR Title
uses: amannn/action-semantic-pull-request@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

- name: Bounty PR Title
if: contains(github.event.pull_request.labels.*.name, '🙋 Bounty claim')
uses: amannn/action-semantic-pull-request@v5
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
with:
requireScope: true
scopes: \d+
26 changes: 26 additions & 0 deletions .github/workflows/grammar-check.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
name: Check grammar

on:
pull_request:
paths:
- "docs/**"
- "**.md"

jobs:
check-grammar:
runs-on: ubuntu-latest

steps:
- name: Checkout code
uses: actions/checkout@v4

- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: "19"

- name: Install write-good
run: npm install write-good

- name: Check grammar
run: npx write-good docs/*.md --no-tooWordy --no-passive --no-illusion --no-weasel --no-adverb
59 changes: 59 additions & 0 deletions .github/workflows/update-releases.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,59 @@
name: Update Releases

on:
schedule:
- cron: "0 */4 * * *"

permissions:
contents: write
pull-requests: write

jobs:
update-releases:
if: github.repository == 'tailcallhq/tailcallhq.github.io' && github.ref == 'refs/heads/develop'
runs-on: ubuntu-latest

steps:
- name: Checkout
uses: actions/checkout@v3
with:
fetch-depth: 0

- name: Set up Node.js
uses: actions/setup-node@v3
with:
node-version: 20

- name: Check for Existing Pull Request
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
EXISTING_PR=$(gh pr list --state open --base develop --json headRefName --jq '.[] | select(.headRefName | startswith("update-releases")) | .headRefName')
if [ -n "$EXISTING_PR" ]; then
echo "An existing PR is already open. Exiting workflow."
exit 1
else
echo "No existing PR found. Proceeding with new PR creation."
fi

- name: Run npm Install
run: npm install

- name: Run Releases Docs Generator Script
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: node release-notes-generator.js

- name: Create Pull Request
uses: peter-evans/create-pull-request@v7
with:
token: ${{ secrets.GITHUB_TOKEN }}
commit-message: "chore: updated releases"
branch: update-releases
branch-suffix: timestamp
base: develop
title: "chore: updated releases"
body: |
This is an auto-generated pull request that updates releases.
reviewers: tusharmath
maintainer-can-modify: true
27 changes: 27 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
# Dependencies
/node_modules

# Production
/build

# Generated files
.docusaurus
.cache-loader

# Misc
.DS_Store
.env.local
.env.development.local
.env.test.local
.env.production.local

npm-debug.log*
yarn-debug.log*
yarn-error.log*
.yarn/

.idea/
src/*/*.json
.vscode/
.gitpod.yml
cypress/screenshots
7 changes: 7 additions & 0 deletions .prettierrc
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"semi": false,
"printWidth": 120,
"bracketSpacing": false,
"overrides": [{"files": "*.md", "options": {"printWidth": 60}}],
"plugins": ["prettier-plugin-sh"]
}
Loading
Loading