#### Sequence diagram for Jekyll site build and deploy workflow

## Reviewer's Guide

Introduce a new GitHub Actions workflow to build and deploy a Jekyll site to GitHub Pages, incorporating permissions, concurrency control, and separate build and deployment jobs.

#### Sequence diagram for Jekyll site build and deploy workflow

```mermaid
sequenceDiagram
participant GitHub as "GitHub Repository"
participant Actions as "GitHub Actions Workflow"
participant Build as "Build Job"
participant Deploy as "Deploy Job"
participant Pages as "GitHub Pages"
GitHub->>Actions: Push to main branch or manual dispatch
Actions->>Build: Start build job
Build->>Build: Checkout code
Build->>Build: Setup Ruby
Build->>Build: Setup Pages
Build->>Build: Build with Jekyll
Build->>Build: Upload artifact (_site)
Build->>Deploy: Signal build completion
Deploy->>Deploy: Deploy to GitHub Pages
Deploy->>Pages: Publish site
```

### File-Level Changes

| Change | Details | Files |
| ------ | ------- | ----- |
| Add workflow configuration and triggers for Jekyll deployment |

• Create .github/workflows/jekyll.yml file
• Define push(main) and manual dispatch triggers
• Set GITHUB_TOKEN permissions for contents read, pages write, and id-token write
• Configure concurrency group “pages” without cancelling in-progress runs

| `.github/workflows/jekyll.yml` |
| Implement build job steps |

• Checkout repository using actions/checkout@v4
• Setup Ruby 3.1 with bundler caching via ruby/setup-ruby
• Configure Pages context with actions/configure-pages@v5
• Run Jekyll build targeting base_path output directory
• Upload generated _site as artifact using actions/upload-pages-artifact@v3

| `.github/workflows/jekyll.yml` |
| Implement deployment job |

• Declare github-pages environment and capture page URL
• Deploy artifact to GitHub Pages via actions/deploy-pages@v4

| `.github/workflows/jekyll.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/10#issuecomment-3394206357_