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

chore: modify project structure & cleanup ci and gitignore #55

Merged
merged 1 commit into from
May 22, 2024
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
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
name: Basic CI
name: Basic CI Workflow

on:
workflow_call:
Expand Down
25 changes: 0 additions & 25 deletions .github/workflows/ci-hertzbeat.yml

This file was deleted.

42 changes: 41 additions & 1 deletion .github/workflows/ci.yml
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,48 @@ jobs:
- name: 'springboot'
language: 'java'
with_oceanbase_container: true
uses: ./.github/workflows/basic-ci.yml
uses: ./.github/workflows/basic-workflow.yml
with:
module: ${{ matrix.module.name }}
language: ${{ matrix.module.language }}
with_oceanbase_container: ${{ matrix.module.with_oceanbase_container }}

application-hertzbeat:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Setup Java Env
uses: actions/setup-java@v4
with:
java-version: '17'
distribution: 'zulu'
cache: 'maven'
- name: Start OceanBase container
uses: oceanbase/setup-oceanbase-ce@v1
with:
network: 'host'
- name: Build and Test
run: |
cd applications/hertzbeat
mvn clean test

application-sveltekit:
runs-on: ubuntu-latest
steps:
- name: Check out repository code
uses: actions/checkout@v4
- name: Setup Node.js env
uses: actions/setup-node@v4
with:
node-version: 21
cache: 'npm'
cache-dependency-path: applications/sveltekit
- uses: pnpm/action-setup@v4
name: Setup pnpm
with:
version: 8
run_install: false
- name: Build and run sample
run: |
cd applications/sveltekit
pnpm install
267 changes: 1 addition & 266 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -43,271 +43,6 @@ build/
*.log
/logs



### Sveltekit/node ###

### JavaScript ###
node_modules
# Keep environment variables out of version control
.env
/.svelte-kit
.svelte-kit

# Logs
logs
*.log
npm-debug.log*
yarn-debug.log*
yarn-error.log*
lerna-debug.log*
.pnpm-debug.log*

# Diagnostic reports (https://nodejs.org/api/report.html)
report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json

# Runtime data
pids
*.pid
*.seed
*.pid.lock

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage
*.lcov

# nyc test coverage
.nyc_output

# Grunt intermediate storage (https://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# Bower dependency directory (https://bower.io/)
bower_components

# node-waf configuration
.lock-wscript

# Compiled binary addons (https://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules/
jspm_packages/

# Snowpack dependency directory (https://snowpack.dev/)
web_modules/

# TypeScript cache
*.tsbuildinfo

# Optional npm cache directory
.npm

# Optional eslint cache
.eslintcache

# Optional stylelint cache
.stylelintcache

# Microbundle cache
.rpt2_cache/
.rts2_cache_cjs/
.rts2_cache_es/
.rts2_cache_umd/

# Optional REPL history
.node_repl_history

# Output of 'npm pack'
*.tgz

# Yarn Integrity file
.yarn-integrity

# dotenv environment variable files
.env
.env.development.local
.env.test.local
.env.production.local
.env.local

# parcel-bundler cache (https://parceljs.org/)
.cache
.parcel-cache

# Next.js build output
.next
out

# Nuxt.js build / generate output
.nuxt
dist

# Gatsby files
.cache/
# Comment in the public line in if your project uses Gatsby and not Next.js
# https://nextjs.org/blog/next-9-1#public-directory-support
# public

# vuepress build output
.vuepress/dist

# vuepress v2.x temp and cache directory
.temp
.cache

# Docusaurus cache and generated files
.docusaurus

# Serverless directories
.serverless/

# FuseBox cache
.fusebox/

# DynamoDB Local files
.dynamodb/

# TernJS port file
.tern-port

# Stores VSCode versions used for testing VSCode extensions
.vscode-test

# yarn v2
.yarn/cache
.yarn/unplugged
.yarn/build-state.yml
.yarn/install-state.gz
.pnp.*

### Python ###

# Editors
.vscode/
.idea/

# Vagrant
.vagrant/

# Mac/OSX
.DS_Store

# Windows
Thumbs.db

# Source for the following rules: https://raw.githubusercontent.com/github/gitignore/master/Python.gitignore
# Byte-compiled / optimized / DLL files
__pycache__/
*.py[cod]
*$py.class

# C extensions
*.so

# Distribution / packaging
.Python
build/
develop-eggs/
dist/
downloads/
eggs/
.eggs/
lib/
lib64/
parts/
sdist/
var/
wheels/
*.egg-info/
.installed.cfg
*.egg
MANIFEST

# PyInstaller
# Usually these files are written by a python script from a template
# before PyInstaller builds the exe, so as to inject date/other infos into it.
*.manifest
*.spec

# Installer logs
pip-log.txt
pip-delete-this-directory.txt

# Unit test / coverage reports
htmlcov/
.tox/
.nox/
.coverage
.coverage.*
.cache
nosetests.xml
coverage.xml
*.cover
.hypothesis/
.pytest_cache/

# Translations
*.mo
*.pot

# Django stuff:
*.log
local_settings.py
db.sqlite3

# Flask stuff:
instance/
.webassets-cache

# Scrapy stuff:
.scrapy

# Sphinx documentation
docs/_build/

# PyBuilder
target/

# Jupyter Notebook
.ipynb_checkpoints

# IPython
profile_default/
ipython_config.py

# pyenv
.python-version

# celery beat schedule file
celerybeat-schedule

# SageMath parsed files
*.sage.py

# Environments
.env
.venv
env/
venv/
ENV/
env.bak/
venv.bak/

# Spyder project settings
.spyderproject
.spyproject

# Rope project settings
.ropeproject

# mkdocs documentation
/site

# mypy
.mypy_cache/
.dmypy.json
dmypy.json
11 changes: 5 additions & 6 deletions README-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,8 @@
如下是本仓库已经添加或计划在近期添加的示例:

- application
- TODO: `hertzbeat` `seatunnel`
- `hertzbeat` `sveltekit`
- TODO: `seatunnel`
- c
- TODO: `obconnector-c`
- c_plusplus
Expand All @@ -32,10 +33,8 @@
- `go-sql-driver`
- TODO: `gorm` `xorm` `obkv-table-client-go`
- java
- `mybatis-plus` `mysql-connector-java` `oceanbase-client` `testcontainers-java`
- TODO: `mybatis` `hibernate` `spring-jdbc` `spring-data-jpa` `hikaricp` `flink-cdc` `oblogclient` `obkv-table-client-java`
- javascript
- `sveltekit`
- `mybatis` `mybatis-plus` `mysql-connector-java` `oceanbase-client` `spring-jdbc` `springboot` `testcontainers-java`
- TODO: `hibernate` `spring-data-jpa` `hikaricp` `flink-cdc` `oblogclient` `obkv-table-client-java`
- php
- TODO: `mysqli` `pdo`
- python
Expand All @@ -60,7 +59,7 @@

如果您不能提供英文的文档,您可以在文档中使用您的母语,我们会在之后对其进行改进。

为了确保示例能够在 GitHub Action 中运行,您的模块添加到 GitHub CI 工作流程。本项目对简单示例提供了一套标准化的运行流程,详情请参阅 [basic-ci.yml](./.github/workflows/basic-ci.yml)。您只需要添加以下内容,将您贡献的模块增加到 [ci.yml](./.github/workflows/ci.yml) 中的 basic job 中即可:
为了确保示例能够在 GitHub Action 中运行,您的模块添加到 GitHub CI 工作流程。本项目对简单示例提供了一套标准化的运行流程,详情请参阅 [basic-workflow.yml](./.github/workflows/basic-workflow.yml)。您只需要添加以下内容,将您贡献的模块增加到 [ci.yml](./.github/workflows/ci.yml) 中的 basic job 中即可:

- `module.name`:新模块的名称,应与模块目录名称相同。
- `module.language`:编程语言,应与项目根目录下的目录名称相同。
Expand Down
Loading
Loading