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.

Sign up for GitHub

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

Standardize Terminology and Fix Formatting in Documentation and Actions #21201

Closed
wants to merge 3 commits into from
Closed

Standardize Terminology and Fix Formatting in Documentation and Actions #21201

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1a2159b
Update README.md
podZzzzz Feb 10, 2025
865b783
Update doc-bug.md
podZzzzz Feb 13, 2025
03f9a12
Update action.yml
podZzzzz Feb 13, 2025
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/doc-bug.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
---
name: Sui doc content issue or request
about: Creates an issue for Sui documentation
about: Create an issue for Sui documentation
title: 'Sui doc content issue or request'
labels: doc-issue
assignees: 'ronny-mysten'
Expand Down
18 changes: 9 additions & 9 deletions .github/actions/ts-e2e/action.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name: Detect Changes in Turbo Workspace
description: Run e2e tests with specified branch
description: Run E2E tests with specified branch

inputs:
ref:
description: 'The branch to checkout and run e2e tests on'
description: 'The branch to checkout and run E2E tests on'
required: true

runs:
Expand All @@ -27,12 +27,12 @@ runs:
shell: bash

- name: cargo build
if: env.s3_file_exist == '' # if empty, we have not built and uploaded this binary to s3 yet
if: env.s3_file_exist == '' # if empty, we have not built and uploaded this binary to S3 yet
run: cargo build --bin sui
shell: bash

- name: Dowload from S3
if: env.s3_file_exist != '' # only download if the s3 file exists
- name: Download from S3
if: env.s3_file_exist != '' # only download if the S3 file exists
working-directory: ./target/debug
run: |
mkdir -p $PWD/target/debug
Expand All @@ -45,10 +45,10 @@ runs:
with:
clean: false

- name: Install Nodejs
- name: Install Node.js
uses: actions/setup-node@60edb5dd545a775178f52524783378180af0d1f8 # [email protected]
with:
node-version: '18'
node-version: 18
cache: 'pnpm'
- name: Install dependencies
run: pnpm install --frozen-lockfile
Expand All @@ -60,11 +60,11 @@ runs:
echo "VITE_SUI_BIN=$PWD/target/debug/sui" >> $GITHUB_ENV
shell: bash

- name: Run TS SDK e2e tests
- name: Run TS SDK E2E tests
run: pnpm dlx concurrently --kill-others --success command-1 "$E2E_RUN_LOCAL_NET_CMD" 'pnpm --filter @mysten/sui test:e2e'
shell: bash

- name: Run TS SDK GraphQL compatibility e2e tests
- name: Run TS SDK GraphQL compatibility E2E tests
if: (!contains(fromJSON('["testnet", "devnet"]'), inputs.ref))
run: pnpm dlx concurrently --kill-others --success command-1 "$E2E_RUN_LOCAL_NET_CMD" 'pnpm --filter @mysten/graphql-transport test:e2e'
shell: bash
2 changes: 1 addition & 1 deletion crates/sui-tool/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ cargo run --bin sui-tool -- anemo ping --server-name "$SERVER_NAME" "$ADDRESS"

### call

`sui-tool` has been preconfigured to support RPC calls using [RON (Rusty Object Notation)](https://crates.io/crates/ron) for the following servivces:
`sui-tool` has been preconfigured to support RPC calls using [RON (Rusty Object Notation)](https://crates.io/crates/ron) for the following services:
- Narwhal: `PrimaryToPrimary` and `WorkerToWorker`
- Sui: `Discovery` and `StateSync`

Expand Down
Loading