Skip to content

Sequence diagram for publishing with prohibited file removal #64

@Dargon789

Description

@Dargon789

Reviewer's Guide

This PR streamlines and expands CI/CD configurations by swapping custom actions for standardized GitHub workflows with caching and Node setup, adds new deployment and CircleCI pipelines, enforces removal of prohibited files in publishing, and bumps key workspace dependencies.

Sequence diagram for publishing with prohibited file removal

sequenceDiagram
  participant Runner as "CI Runner"
  participant Repo as "Repository"
  Runner->>Repo: echo "prohibited_file" >> .gitignore
  Runner->>Repo: git rm --cached prohibited_file
  Runner->>Repo: git commit -m "Remove prohibited_file"
  Runner->>Repo: mkdir -p /tmp/$PACKAGE
  Runner->>Repo: cp -r $PKG_DIR/* /tmp/$PACKAGE
Loading

Class diagram for updated package dependencies

classDiagram
  class DocsPackageJson {
    +@repo/ui: workspace:*
    +next: ^15.2.4
    +react: ^19.0.0
    +react-dom: ^19.0.0
  }
  class WebPackageJson {
    +@repo/ui: workspace:*
    +next: ^15.2.4
    +react: ^19.0.0
    +react-dom: ^19.0.0
  }
  class WalletWdkPackageJson {
    +@types/node: ^22.13.9
    +dotenv: ^16.4.7
    +fake-indexeddb: ^6.0.0
    +happy-dom: ^15.10.2
    +typescript: ^5.7.3
    +vitest: ^3.1.2
  }
Loading

File-Level Changes

Change Details Files
Standardize and optimize GitHub Actions for Node workflows
  • Replace custom install script with actions/setup-node@v4
  • Add pnpm cache action keyed by lockfile hash
  • Configure pnpm fetch retries and run pnpm install
  • Remove redundant install steps in build and test jobs
.github/workflows/tests.yml
Enforce removal of prohibited file before publishing
  • Append prohibited_file to .gitignore
  • Untrack prohibited_file with git rm --cached
  • Commit removal with a descriptive message
.github/workflows/publish-dists.yml
Bump Next.js and other dependencies across workspace packages
  • Upgrade next from ^15.1.0 to ^15.2.4 in docs and web
  • Update happy-dom from ^13.2.0 to ^15.10.2 in wallet wdk
  • Regenerate pnpm-lock.yaml to reflect updated versions
extras/docs/package.json
extras/web/package.json
packages/wallet/wdk/package.json
pnpm-lock.yaml
Introduce GitHub Actions Next.js deployment workflow
  • Add nextjs.yml with checkout, detection of package manager
  • Setup Node 20 with caching and configure-pages action
  • Add build and deploy jobs for Pages via upload-pages-artifact
.github/workflows/nextjs.yml
Add new CircleCI configurations for Rust and custom executor
  • Create ci_cargo.yml for cargo build/test and cache
  • Create config.yml defining a custom Docker executor and sample job
.circleci/ci_cargo.yml
.circleci/config.yml

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Originally posted by @sourcery-ai[bot] in #61 (comment)

Metadata

Metadata

Assignees

Labels

bugSomething isn't workingdependenciesPull requests that update a dependency filedocumentationImprovements or additions to documentationduplicateThis issue or pull request already existsenhancementNew feature or requestgood first issueGood for newcomersinvalidThis doesn't seem rightjavascriptPull requests that update javascript codequestionFurther information is requestedwontfixThis will not be worked on

Projects

Status

Done

Status

Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions