diff --git a/docs/content/4.changelog/github-app-and-action.md b/docs/content/4.changelog/github-app-and-action.md index 64144882..df7a4768 100644 --- a/docs/content/4.changelog/github-app-and-action.md +++ b/docs/content/4.changelog/github-app-and-action.md @@ -2,7 +2,7 @@ title: NuxtHub GitHub App & Action description: "Introducing our GitHub App & Action for automating your Nuxt deployments with GitHub as well as a new project creation flow." date: 2024-12-12 -image: '/images/changelog/cloudflare-access.png' +image: '/images/changelog/nuxthub-github-app-action.png' authors: - name: Rihan Arfan avatar: @@ -13,27 +13,38 @@ authors: We're thrilled to release our brand new [GitHub Application](https://github.com/apps/nuxthub-admin) & [GitHub Action](https://github.com/marketplace/actions/deploy-to-nuxthub) to help you create and deploy Nuxt applications to NuxtHub. - -## Features +## Pull Request Integration -**Pull Request Integration**: Automated comments on PRs with branch URLs, permalinks, and QR codes for easy preview access +Once setup, NuxtHub will automatically comment on pull requests with branch URLs, permalinks and QR codes for easy preview access. -:nuxt-img{src="/images/changelog/github-action-pr-comment.png" alt="NuxtHub GitHub Action pull request comment" width="810" height="760"} +:nuxt-img{src="/images/changelog/nuxthub-github-app-action.png" alt="GitHub Action" width="926" height="520"} -**GitHub Deployments**: Full integration with GitHub's deployment system, including status updates and environment tracking +## GitHub Deployments -:nuxt-img{src="/images/changelog/github-action-deployment.jpeg" alt="NuxtHub GitHub Action deployments" width="1027" height="628"} +NuxtHub also integrates with GitHub's deployment system, including status updates and environment tracking. + +:nuxt-img{src="/images/changelog/nuxthub-github-action-deployment.png" alt="NuxtHub GitHub Action deployments" width="926" height="521"} This includes GitHub Deployments support in pull requests. -:nuxt-img{src="/images/changelog/github-action-deployment-2.png" alt="NuxtHub GitHub Action pull request deployment" width="810" height="445"} +:nuxt-img{src="/images/changelog/nuxthub-github-action-deployment-pr.png" alt="NuxtHub GitHub Action deployments" width="926" height="219"} And many more: - **Deployment Protection**: Support for GitHub's deployment protection rules which enable approval workflows and environment restrictions ([learn more on GitHub's documentation](https://docs.github.com/en/actions/managing-workflow-runs-and-deployments/managing-deployments/managing-environments-for-deployment#deployment-protection-rules)) - **Secure**: Our GitHub integration prevents the need for long-lived secrets as it uses OIDC under the hood - **Customizable**: You can create tailored workflows to fit your DevOps requirements using our GitHub Action +## Cloning a Template + +Thanks to the new GitHub App, you can now clone a template from NuxtHub Admin and deploy it with a single click. + +:nuxt-img{src="/images/changelog/nuxthub-github-app-clone-template.png" alt="NuxtHub GitHub App clone template" width="2596" height="1460"} + +::note +The repository will be created in your GitHub account with the GitHub Actions workflow already configured. +:: + ## Migrating to GitHub Actions Migrating from Cloudflare Pages CI or the legacy GitHub Action is simple and can be done from [NuxtHub Admin](https://admin.hub.nuxt.com/) → Project → Settings → Git. @@ -43,7 +54,7 @@ Migrating from Cloudflare Pages CI or the legacy GitHub Action is simple and can When migrating from Cloudflare Pages CI, please note: - Deployment quotas will shift from [Pages CI limits](https://developers.cloudflare.com/pages/platform/limits/#builds) to your [GitHub Actions usage](https://docs.github.com/en/billing/managing-billing-for-your-products/managing-billing-for-github-actions/about-billing-for-github-actions#included-storage-and-minutes) -- Environment variables and secrets needed at build time should be managed through [GitHub Environment settings](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#creating-configuration-variables-for-an-environment) +- Environment variables and secrets needed at build time should be managed through [GitHub Environment settings](https://docs.github.com/en/actions/writing-workflows/choosing-what-your-workflow-does/store-information-in-variables#creating-configuration-variables-for-an-environment) (we are working on a way to synchronize them automatically) ::callout{to="/docs/getting-started/deploy#github-action" icon="i-lucide-book"} Learn more about deploying with GitHub Actions to NuxtHub. diff --git a/docs/public/images/changelog/github-action-deployment.jpeg b/docs/public/images/changelog/github-action-deployment.jpeg deleted file mode 100644 index 4b536ede..00000000 Binary files a/docs/public/images/changelog/github-action-deployment.jpeg and /dev/null differ diff --git a/docs/public/images/changelog/github-action-pr-comment.png b/docs/public/images/changelog/github-action-pr-comment.png deleted file mode 100644 index 938bfc3b..00000000 Binary files a/docs/public/images/changelog/github-action-pr-comment.png and /dev/null differ diff --git a/docs/public/images/changelog/nuxthub-github-action-deployment-pr.png b/docs/public/images/changelog/nuxthub-github-action-deployment-pr.png new file mode 100644 index 00000000..240b72e7 Binary files /dev/null and b/docs/public/images/changelog/nuxthub-github-action-deployment-pr.png differ diff --git a/docs/public/images/changelog/nuxthub-github-action-deployment.png b/docs/public/images/changelog/nuxthub-github-action-deployment.png new file mode 100644 index 00000000..d3697669 Binary files /dev/null and b/docs/public/images/changelog/nuxthub-github-action-deployment.png differ diff --git a/docs/public/images/changelog/nuxthub-github-app-action.png b/docs/public/images/changelog/nuxthub-github-app-action.png new file mode 100644 index 00000000..9afa4e7b Binary files /dev/null and b/docs/public/images/changelog/nuxthub-github-app-action.png differ diff --git a/docs/public/images/changelog/nuxthub-github-app-clone-template.png b/docs/public/images/changelog/nuxthub-github-app-clone-template.png new file mode 100644 index 00000000..1b9eed25 Binary files /dev/null and b/docs/public/images/changelog/nuxthub-github-app-clone-template.png differ