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

restructure packages by language #1

Merged
merged 3 commits into from
Apr 18, 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
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
16 changes: 10 additions & 6 deletions .github/workflows/docs-test.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,18 @@
name: Test Docs deployment
name: Docs Test

on:
pull_request:
branches:
- main
paths:
- packages/docs/**
- docs/**
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

defaults:
run:
working-directory: ./packages/docs
# cancel previous tests if new commit is pushed to PR branch
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

jobs:
test-docs:
Expand All @@ -25,9 +26,12 @@ jobs:
with:
node-version: 18
cache: npm
cache-dependency-path: './packages/docs/package-lock.json'
cache-dependency-path: ./docs/package-lock.json

- name: Install dependencies
working-directory: ./docs
run: npm ci

- name: Test build website
working-directory: ./docs
run: npm run build
12 changes: 6 additions & 6 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
name: Deploy Docs to GitHub Pages
name: Docs deploy to GitHub Pages

on:
push:
branches:
- main
paths:
- packages/docs/**
- docs/**
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:

Expand All @@ -29,20 +29,20 @@ jobs:
with:
node-version: 18
cache: npm
cache-dependency-path: './packages/docs/package-lock.json'
cache-dependency-path: ./docs/package-lock.json

- name: Install Dependencies
working-directory: './packages/docs'
working-directory: ./docs
run: npm ci

- name: Build
working-directory: './packages/docs'
working-directory: ./docs
run: npm run build

- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: './packages/docs/build'
path: ./docs/build
deploy:
name: Deploy to GitHub Pages
needs: build
Expand Down
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
name: Test Java CI
name: Java json-transform Test

on:
push:
branches: [ "main" ]
paths:
- '!packages/**'
- java/json-transform/**
pull_request:
branches: [ "main" ]
paths:
- '!packages/**'
- java/json-transform/**

# cancel previous tests if new commit is pushed to PR branch
concurrency:
Expand Down Expand Up @@ -43,7 +43,16 @@ jobs:
with:
# build includes tests
arguments: |
build
:java:json-transform:build
--console=plain
--parallel
-Dorg.gradle.parallel.intra=true

- name: Run benchmarking tests with Gradle
uses: gradle/[email protected]
with:
arguments: |
:java:json-transform:jmh
--console=plain
--parallel
-Dorg.gradle.parallel.intra=true
Expand All @@ -52,7 +61,7 @@ jobs:
uses: dorny/test-reporter@v1
if: success() || failure() # run this step even if previous step failed
with:
name: Test Results # Name of the check run which will be created
name: Java json-transform Test Results # Name of the check run which will be created
path: '**/build/test-results/test/*.xml' # Path to test results
reporter: java-junit # Format of test results
list-suites: 'failed' # Limits which test suites are listed: (*all/failed) *default
Expand Down
Original file line number Diff line number Diff line change
@@ -1,20 +1,17 @@
name: Run Tests
name: JavaScript json-transform-core Test

on:
pull_request:
branches:
- main
paths:
- packages/json-transform-core/**
- javascript/json-transform-core/**

# cancel previous tests if new commit is pushed to PR branch
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

defaults:
run:
working-directory: ./packages/json-transform-core

jobs:
test:
runs-on: ubuntu-latest
Expand All @@ -25,8 +22,12 @@ jobs:
with:
node-version: 18
cache: npm
cache-dependency-path: './packages/json-transform-core/package-lock.json'
cache-dependency-path: ./javascript/json-transform-core/package-lock.json

- name: Install dependencies
working-directory: ./javascript/json-transform-core
run: npm ci

- name: Run tests
working-directory: ./javascript/json-transform-core
run: npm test
30 changes: 6 additions & 24 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,28 +1,10 @@
# json-transform

[![Maven Central Version](https://img.shields.io/maven-central/v/co.nlighten/json-transform)](https://central.sonatype.com/artifact/co.nlighten/json-transform)
[![javadoc](https://javadoc.io/badge2/co.nlighten/json-transform/javadoc.svg?)](https://javadoc.io/doc/co.nlighten/json-transform)
[![Build](https://github.com/nlighten-oss/json-transform/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/nlighten-oss/json-transform/actions/workflows/ci.yml)
[![GitHub Release](https://img.shields.io/github/v/release/nlighten-oss/json-transform?)](https://github.com/nlighten-oss/json-transform/releases)
[![License](https://img.shields.io/github/license/nlighten-oss/json-transform)](./LICENSE)
- [Documentation](https://nlighten-oss.github.io/json-transform/)

## Packages

## Installation

Maven
```xml
<dependency>
<groupId>co.nlighten</groupId>
<artifactId>json-transform</artifactId>
<version>0.2.0</version>
</dependency>
```

Gradle
```groovy
implementation 'co.nlighten:json-transform:0.2.0'
```

## License

[Apache License 2.0](./LICENSE)
|Language|Name|Description|License|Status|
|---|---|---|---|---|
|Java|[co.nlighten.json-transform](./java/json-transform)|Java library for transforming JSON objects|Apache License 2.0|![Maven Central Version](https://img.shields.io/maven-central/v/co.nlighten/json-transform)|
|JavaScript|[@nlighten/json-transform-core](./javascript/json-transform-core)|Core types and utilities for handling JSON transformers|MIT|![npm](https://img.shields.io/npm/v/@nlighten/json-transform-core)|
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ const config: Config = {
sidebarPath: "./sidebars.ts",
// Please change this to your repo.
// Remove this to remove the "edit this page" links.
editUrl: "https://github.com/nlighten-oss/json-transform/tree/main/packages/docs/",
editUrl: "https://github.com/nlighten-oss/json-transform/tree/main/docs/",
},
theme: {
customCss: "./src/css/custom.css",
Expand Down
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes
File renamed without changes.
File renamed without changes.
28 changes: 28 additions & 0 deletions java/json-transform/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
# co.nlighten.json-transform

[![Maven Central Version](https://img.shields.io/maven-central/v/co.nlighten/json-transform)](https://central.sonatype.com/artifact/co.nlighten/json-transform)
[![javadoc](https://javadoc.io/badge2/co.nlighten/json-transform/javadoc.svg?)](https://javadoc.io/doc/co.nlighten/json-transform)
[![Build](https://github.com/nlighten-oss/json-transform/actions/workflows/java-json-transform-test.yml/badge.svg?branch=main)](https://github.com/nlighten-oss/json-transform/actions/workflows/java-json-transform-test.yml)
[![GitHub Release](https://img.shields.io/github/v/release/nlighten-oss/json-transform?)](https://github.com/nlighten-oss/json-transform/releases)
[![License](https://img.shields.io/github/license/nlighten-oss/json-transform)](./LICENSE)


## Installation

Maven
```xml
<dependency>
<groupId>co.nlighten</groupId>
<artifactId>json-transform</artifactId>
<version>0.2.0</version>
</dependency>
```

Gradle
```groovy
implementation 'co.nlighten:json-transform:0.2.0'
```

## License

[Apache License 2.0](./LICENSE)
File renamed without changes.
Loading
Loading