![\"GitHub](\"https://github.com/JamesIves/github-pages-deploy-action/raw/dev/.github/docs/icon.png\"){kind=icon}
\n \n\n \n \n \n
\n Automatically deploy your project to GitHub Pages with GitHub Actions. This action can be configured to push your production-ready code into any branch you'd like, including gh-pages and docs. It can also handle cross repository deployments and works with GitHub Enterprise too.\n
\n\n\n ![\"\"](\"https://github.com/JamesIves/github-pages-deploy-action/raw/dev/.github/docs/screenshot.png\")
\n
\nMaintenance of this project is made possible by all the contributors and sponsors. If you'd like to sponsor this project and have your avatar or company logo appear below click here. 💖\n
\n\n\n![\"github\"](\"https://github.com/github.png\")
![\"annegentle\"](\"https://github.com/annegentle.png\")
![\"tonjohn\"](\"https://github.com/tonjohn.png\")
![\"Zhenglei-BCS\"](\"https://github.com/Zhenglei-BCS.png\")
![\"\"](\"https://github.com/.png\")
\n
\n![\"Chooksta69\"](\"https://github.com/Chooksta69.png\")
![\"MattWillFlood\"](\"https://github.com/MattWillFlood.png\")
![\"jonathan-milan-pollock\"](\"https://github.com/jonathan-milan-pollock.png\")
![\"raoulvdberge\"](\"https://github.com/raoulvdberge.png\")
![\"robjtede\"](\"https://github.com/robjtede.png\")
![\"hadley\"](\"https://github.com/hadley.png\")
![\"kevinchalet\"](\"https://github.com/kevinchalet.png\")
![\"Yousazoe\"](\"https://github.com/Yousazoe.png\")
![\"planetoftheweb\"](\"https://github.com/planetoftheweb.png\")
![\"melton1968\"](\"https://github.com/melton1968.png\")
![\"szepeviktor\"](\"https://github.com/szepeviktor.png\")
![\"sckott\"](\"https://github.com/sckott.png\")
![\"provinzkraut\"](\"https://github.com/provinzkraut.png\")
![\"electrovir\"](\"https://github.com/electrovir.png\")
![\"Griefed\"](\"https://github.com/Griefed.png\")
![\"MontezumaIves\"](\"https://github.com/MontezumaIves.png\")
![\"wylie\"](\"https://github.com/wylie.png\")
![\"pylapp\"](\"https://github.com/pylapp.png\")
\n
\n\n```yml\nname: Build and Deploy\non:\n push:\n branches:\n - main\njobs:\n deploy:\n concurrency: ci-${{ github.ref }}\n runs-on: ubuntu-latest\n steps:\n - name: Checkout 🛎️\n uses: actions/checkout@v4\n\n - name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.\n run: |\n npm ci\n npm run build\n\n - name: Deploy 🚀\n uses: JamesIves/github-pages-deploy-action@v4\n with:\n folder: build\n clean: true\n clean-exclude: |\n special-file.txt\n some/*.txt\n ssh-key: ${{ secrets.DEPLOY_KEY }}\n```\n\n
\n\n\n```yml\nname: Build and Deploy\non: [push]\npermissions:\n contents: write\njobs:\n build:\n runs-on: windows-latest # The first job utilizes windows-latest\n steps:\n - name: Checkout 🛎️\n uses: actions/checkout@v4\n\n - name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.\n run: |\n npm ci\n npm run build\n\n - name: Upload Artifacts 🔺 # The project is then uploaded as an artifact named 'site'.\n uses: actions/upload-artifact@v1\n with:\n name: site\n path: build\n\n deploy:\n concurrency: ci-${{ github.ref }}\n needs: [build] # The second job must depend on the first one to complete before running and uses ubuntu-latest instead of windows.\n runs-on: ubuntu-latest\n steps:\n - name: Checkout 🛎️\n uses: actions/checkout@v4\n\n - name: Download Artifacts 🔻 # The built project is downloaded into the 'site' folder.\n uses: actions/download-artifact@v1\n with:\n name: site\n\n - name: Deploy 🚀\n uses: JamesIves/github-pages-deploy-action@v4\n with:\n folder: 'site' # The deployment folder should match the name of the artifact. Even though our project builds into the 'build' folder the artifact name of 'site' must be placed here.\n```\n\n
\n\n\n```yml\nname: Build and Deploy\npermissions:\n contents: write\non:\n push:\n branches:\n - main\njobs:\n deploy:\n concurrency: ci-${{ github.ref }}\n runs-on: ubuntu-latest\n steps:\n - name: Checkout 🛎️\n uses: actions/checkout@v4\n\n - name: Install and Build 🔧 # This example project is built using npm and outputs the result to the 'build' folder. Replace with the commands required to build your project, or remove this step entirely if your site is pre-built.\n run: |\n npm ci\n npm run build\n\n - name: Deploy 🚀\n uses: JamesIves/github-pages-deploy-action@v4\n with:\n folder: build\n clean: true\n clean-exclude: |\n special-file.txt\n some/*.txt\n```\n\n
\n