diff --git a/docs/content/0.index.yml b/docs/content/0.index.yml index a49df931..510a86ca 100644 --- a/docs/content/0.index.yml +++ b/docs/content/0.index.yml @@ -10,8 +10,8 @@ hero: light: '/images/landing/hero-light.svg' dark: '/images/landing/hero-dark.svg' headline: - label: "Cloudflare Access integration" - to: /changelog/cloudflare-access + label: "Github Action" + to: /changelog/github-action icon: i-lucide-arrow-right features: - name: Cloud Hosting diff --git a/docs/content/4.changelog/github-action.md b/docs/content/4.changelog/github-action.md index 3ac0d9cd..f6579373 100644 --- a/docs/content/4.changelog/github-action.md +++ b/docs/content/4.changelog/github-action.md @@ -1,6 +1,6 @@ --- title: GitHub Action -description: "Tighter GitHub integration and improved automated deployments" +description: "Introducing our GitHub Action for improved automated deployments" date: 2024-12-11 image: '/images/changelog/cloudflare-access.png' authors: @@ -11,16 +11,42 @@ authors: username: RihanArfan --- -Summary +We're thrilled to release our brand new [GitHub Action](https://github.com/marketplace/actions/nuxt-hub) for deploying to NuxtHub. Our new GitHub integration sets up a GitHub Actions workflow to automatically deploy your application on every commit. :nuxt-img{src="/images/changelog/cloudflare-access.png" alt="GitHub Action" width="915" height="515"} -Explain features (pr comments, gh deployments, deployment approvals) +## Features -migration guide + screenshot +**GitHub Deployments**: Full integration with GitHub's deployment system, including status updates and environment tracking -caveats (pages ci quota to github actions quota, env variables managed on github) +:nuxt-img{src="/images/changelog/github-action-deployment.jpeg" alt="NuxtHub GitHub Action deployments" width="1027" height="628"} + +**Pull Request Integration**: Automated comments on PRs 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"} + +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"} + +And many more: +- **Deployment Protection**: Support for GitHub's deployment protection rules, enabling 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 + +## Migrating to GitHub Actions + +Migrating from Pages CI or our legacy existing GitHub Actions using NuxtHub CLI recipe is simple, and can be done from [NuxtHub Admin](https://admin.hub.nuxt.com/) → Project → Settings → Git. + + + +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) ::callout{to="/docs/getting-started/deploy#github-action" icon="i-lucide-book"} Learn more about deploying with GitHub Actions to NuxtHub. :: + +P.S. Give our new GitHub Action a star 🌟💚 https://github.com/nuxt-hub/action diff --git a/docs/public/images/changelog/github-action-deployment-2.png b/docs/public/images/changelog/github-action-deployment-2.png new file mode 100644 index 00000000..056008ce Binary files /dev/null and b/docs/public/images/changelog/github-action-deployment-2.png differ diff --git a/docs/public/images/changelog/github-action-deployment.jpeg b/docs/public/images/changelog/github-action-deployment.jpeg new file mode 100644 index 00000000..4b536ede Binary files /dev/null and b/docs/public/images/changelog/github-action-deployment.jpeg differ diff --git a/docs/public/images/changelog/github-action-pr-comment.png b/docs/public/images/changelog/github-action-pr-comment.png new file mode 100644 index 00000000..938bfc3b Binary files /dev/null and b/docs/public/images/changelog/github-action-pr-comment.png differ