Dargon789 / Dargon789/vercel-dev

#### Sequence diagram for Nuxt.js build and deploy workflow

Open
#2 0 comments 0 reactions 1 assignee Claimed by @Dargon789 View on GitHub
Dominant language
TypeScript
Stars
1
Forks
0
PR merge metrics
No merged PRs in 30d

Description

## Reviewer's Guide

Introduce a new GitHub Actions workflow to build and deploy the Nuxt.js site to GitHub Pages.

#### Sequence diagram for Nuxt.js build and deploy workflow

```mermaid
sequenceDiagram
participant Dev as Developer
participant GitHub as GitHub Actions
participant Node as Node.js
participant Nuxt as Nuxt.js
participant Pages as GitHub Pages

Dev->>GitHub: Push to main branch or trigger workflow
GitHub->>GitHub: Start build job
GitHub->>GitHub: Checkout code
GitHub->>GitHub: Detect package manager
GitHub->>Node: Setup Node.js
GitHub->>GitHub: Setup Pages
GitHub->>GitHub: Restore cache
GitHub->>GitHub: Install dependencies
GitHub->>Nuxt: Run static HTML export
Nuxt-->>GitHub: Output static files (dist)
GitHub->>GitHub: Upload artifact
GitHub->>GitHub: Start deploy job
GitHub->>Pages: Deploy to GitHub Pages
Pages-->>Dev: Site available at page_url
```

### File-Level Changes

| Change | Details | Files |
| ------ | ------- | ----- |
| Add nuxtjs.yml workflow file with triggers and permissions |

  • Define triggers on push to main and manual dispatch
  • Configure GITHUB_TOKEN contents, pages, and id-token permissions
| `.github/workflows/nuxtjs.yml` |
| Configure concurrency control for deployments |
  • Set concurrency group to 'pages'
  • Disable cancellation of in-progress runs
| `.github/workflows/nuxtjs.yml` |
| Implement build job for static site generation |
  • Checkout repository using actions/checkout
  • Detect package manager dynamically (npm or yarn)
  • Setup Node.js v20 with caching
  • Restore and manage build cache for dist and .nuxt
  • Install dependencies and run generate
  • Upload dist folder as build artifact
| `.github/workflows/nuxtjs.yml` |
| Implement deploy job to GitHub Pages |
  • Define environment name and deployment URL
  • Deploy the uploaded artifact using actions/deploy-pages
| `.github/workflows/nuxtjs.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](https://app.sourcery.ai) 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

- [Contact our support team](mailto:support@sourcery.ai) for questions or feedback.
- Visit our [documentation](https://docs.sourcery.ai) for detailed guides and information.
- Keep in touch with the Sourcery team by following us on [X/Twitter](https://x.com/SourceryAI), [LinkedIn](https://www.linkedin.com/company/sourcery-ai/) or [GitHub](https://github.com/sourcery-ai).

_Originally posted by @sourcery-ai[bot] in https://github.com/Dargon789/vercel-dev-cloud/issues/1#issuecomment-3348701264_

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.