github-pages-deploy-action | 🚀 Automatically deploy your project to GitHub Pages | Continous Integration library

 by   JamesIves TypeScript Version: 3.5.1 License: MIT

kandi X-RAY | github-pages-deploy-action Summary

kandi X-RAY | github-pages-deploy-action Summary

github-pages-deploy-action is a TypeScript library typically used in Devops, Continous Integration applications. github-pages-deploy-action has no bugs, it has no vulnerabilities, it has a Permissive License and it has medium support. You can download it from GitHub.

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. Maintenance 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. .
Support
    Quality
      Security
        License
          Reuse

            kandi-support Support

              github-pages-deploy-action has a medium active ecosystem.
              It has 3715 star(s) with 324 fork(s). There are 17 watchers for this library.
              OutlinedDot
              It had no major release in the last 12 months.
              There are 5 open issues and 255 have been closed. On average issues are closed in 34 days. There are 4 open pull requests and 0 closed requests.
              It has a neutral sentiment in the developer community.
              The latest version of github-pages-deploy-action is 3.5.1

            kandi-Quality Quality

              github-pages-deploy-action has 0 bugs and 0 code smells.

            kandi-Security Security

              github-pages-deploy-action has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.
              github-pages-deploy-action code analysis shows 0 unresolved vulnerabilities.
              There are 0 security hotspots that need review.

            kandi-License License

              github-pages-deploy-action is licensed under the MIT License. This license is Permissive.
              Permissive licenses have the least restrictions, and you can use them in most projects.

            kandi-Reuse Reuse

              github-pages-deploy-action releases are available to install and integrate.
              Installation instructions, examples and code snippets are available.
              It has 29 lines of code, 0 functions and 26 files.
              It has low code complexity. Code complexity directly impacts maintainability of the code.

            Top functions reviewed by kandi - BETA

            kandi's functional review helps you automatically verify the functionalities of the libraries and avoid rework.
            Currently covering the most popular Java, JavaScript and Python libraries. See a Sample of github-pages-deploy-action
            Get all kandi verified functions for this library.

            github-pages-deploy-action Key Features

            No Key Features are available at this moment for github-pages-deploy-action.

            github-pages-deploy-action Examples and Code Snippets

            No Code Snippets are available at this moment for github-pages-deploy-action.

            Community Discussions

            QUESTION

            how to run GitHub Action after outage?
            Asked 2022-Mar-27 at 00:10

            As you may (or may not) know yesterday was a major incident of GitHub's services: https://www.githubstatus.com/incidents/tyc8wpsgr2r8.

            Unfortunately I published a release during that time and the action responsible for building and publishing the code didn't trigger.

            For actions which executed at least once I have an option to "Re-run workflow" - but how can I proceed with an action which didn't even trigger - I can not see it anywhere whatsoever?

            I think the last resort would be to just make another release, remove the problematic one etc. but I'd like to avoid that.

            The workflow file:

            ...

            ANSWER

            Answered 2022-Mar-27 at 00:10

            As you said in the comment, the easiest solution would be to remove the release and create it all over again.

            Another option could be to add a workflow_dispatch event trigger to the workflow with a tag input, updating the jobs condition to use this input.tag variable if informed.

            That way, if an automatic trigger failed (through push, release or pull_request), you could trigger it manually through the Github UI or the GH CLI as an alternative.

            Source https://stackoverflow.com/questions/71598855

            QUESTION

            How to use environment variables when running Next JS build command on Github Actions
            Asked 2022-Mar-23 at 13:07

            How can I let Github actions access my .env.local file for building my Next JS app without exposing the .env.local file on my github repository?

            Currently, the build will not have access to .env.local when building using Github Actions (because that file is not pushed to the Github repo).

            I have a next.config.js file that looks like

            ...

            ANSWER

            Answered 2022-Mar-23 at 13:07

            Besides the .env.local file, which is typically meant to contain things that are only needed locally, you can also use a file .env, .env.development, or .env.production. These files could then be checked in.

            Your .env file can contain global defaults (e.g. some config). With the others, you can override configs specific to that environment.

            As opposed to the .env.local file, the other three would typically be checked in.

            See their docs for more info.

            Source https://stackoverflow.com/questions/71587658

            QUESTION

            GitHub Action use file of other branch?
            Asked 2022-Feb-13 at 13:06

            The GitHub Action below performs two steps:

            1. long.py fetches the data from an API and saves it but the data rarely changes
            2. quick.py processes the saved data generated by long.py
            ...

            ANSWER

            Answered 2022-Feb-13 at 13:06

            Easiest way is to use caching:

            https://github.com/actions/cache

            You can use hash of your file as a key.

            Source https://stackoverflow.com/questions/71100717

            QUESTION

            GitHub Actions: Required property is missing: shell
            Asked 2022-Feb-09 at 00:46
            Introduction

            I am currently to crate a composite GitHub Actions that build a JavaDoc from Java project and publish it automatically to a static page with GitHub Page.

            Problematic

            But I got this error when I try to run it:

            ...

            ANSWER

            Answered 2022-Feb-09 at 00:46

            When using composite actions, you have to specify shell.

            In your case the problem is in this step, you need to add shell: bash here:

            Source https://stackoverflow.com/questions/71041836

            QUESTION

            Github action fails for build and deploy on Fetch API
            Asked 2021-May-07 at 20:21

            I am using this GitHub action https://github.com/JamesIves/fetch-api-data-action to fetch and save data fetched by an API:

            this is my configuration for 2 actions, one to fetch the API and then build and deploy to save the .json fetching from the API

            ...

            ANSWER

            Answered 2021-May-07 at 19:50

            You are using an old version of that action. Perhaps try moving to v4 which handles some of these parameters differently. If you are pushing back to the same repository you do not even need to pass a token.

            Other than that, I see two possible things to check:

            1. You reference branch main in the first action but master in the second. Are these pointing to the same repository? If so, I'd think the branch names would be the same.

            2. With the v3 component, the docs for ACCESS_TOKEN kind of imply you need to be using a generated Personal Access Token that you have stored in the secrets. That is what I used when using this action although I was pushing to a different repository so the was a must anyway.

            I moved to v4 quite a while ago though.

            Source https://stackoverflow.com/questions/67440780

            QUESTION

            gh-pages deployment issue, job fails on deploy. The directory you're trying to deploy ... doesn't exist
            Asked 2021-Feb-19 at 19:38

            gh-pages deployment fails with next error: My repository failed job

            ...

            ANSWER

            Answered 2021-Feb-19 at 19:36

            I misunderstood the issue message, the problem was not duplicating the problem was the missed inner path passed in FOLDER in gh-pages YML settings

            There was a hint in BUILD step

            And one more thing: do not forget to get and add to GH your personal-access-token

            Source https://stackoverflow.com/questions/66246590

            QUESTION

            Fail to deploy to Github Pages - Blazor webassembly using GitHub Actions
            Asked 2020-Sep-23 at 20:57

            I think I have followed all the steps to deploy Blazor webassembly on GitHub Pages using GitHub Actions which I found from https://www.davideguida.com/how-to-deploy-blazor-webassembly-on-github-pages-using-github-actions/

            But it failed at Deploy to Github Pages step

            • Set up job (Passed)
            • Run actions/checkout@v2 (Passed)
            • Setup .NET Core (Passed)
            • Publish with dotnet (Passed)
            • Deploy to Github Pages (Failed)
            • Post Run actions/checkout@v2 (Passed)
            • Complete job (Passed)

            Here are the error descriptions

            ...

            ANSWER

            Answered 2020-Jul-05 at 18:20

            You need to create a branch named development from master branch and set development branch as default branch in your repository settings.

            This is because your gh-pages.yml files has BASE_BRANCH: development and BRANCH: master

            Source https://stackoverflow.com/questions/62734631

            QUESTION

            Angular : Get `404` after reload with `GitHub` page
            Asked 2020-Sep-12 at 15:55

            I have deployed my Angular website on GitHub page, but I got a problem.

            The below is my route setting:

            ...

            ANSWER

            Answered 2020-Sep-12 at 15:55

            According to the Angular doc, you have to make a copy of index.html and name it 404.html.

            1. When the build is complete, make a copy of docs/index.html and name it docs/404.html.

            bash ng build --prod --output-path docs --base-href//

            Source https://stackoverflow.com/questions/63862046

            QUESTION

            GitHub workflow : one job for each different git actions (push on master, push tags...)
            Asked 2020-Aug-02 at 20:29

            I would like to setup my workflow to do the following:

            • On any event (pull-request, push on any branches)
              • Checkout code
              • Build project
              • Run tests
              • Upload artifacts for other jobs
            • Only when master is pushed
              • Download artifacts from previous job
              • Push GH-pages
            • Only when a tag is pushed
              • Download artifacts from previous job
              • Create a release
              • Upload artifacts to the release

            In my .github/workflows the on directives applies to all jobs so it won't work in my case. On the other hand, the action/upload-artifact only works within the same workflow.

            What is the proper way to achieve the described workflow?

            ...

            ANSWER

            Answered 2020-Aug-02 at 20:29

            You could add conditions to your steps and simply skip parts which aren't needed, see jobs..steps.if. As for what to check, github context is a goldmine of various data related to currently running workflow. For example

            Source https://stackoverflow.com/questions/63220262

            QUESTION

            Embed GitHub Secret in React and Deploy to GitHub Page Revealed my Personal Access Token
            Asked 2020-Jun-07 at 04:53

            My goal: my react app has an environment variable to store a Github Personal_Access_Token(later used in HTTP header for a fetch), then I will later deploy the app to Github page using Action Workflow.

            What I tried: Given that pushing/exposing token as plain text to Githut is a violation, I would use Github secrets to avoid it. I found this post and tried to implement Github Workflow to access the secret then deploy.

            ...

            ANSWER

            Answered 2020-Jun-07 at 04:53

            The problem is that React is purely a front-end framework. Everything that should be available directly in React is also available to your users to see. There's no way around this!

            To really keep the secret private it has to be somewhere server side and not on the front-end. One way you could do this is make a "serverless function" (there are multiple generous free offers available on different services). Then you proxy through there, which basically means that:

            1. Your react front-end fetches from your serverless function without any secret.
            2. Your serverless function has the secret stored and does the same fetch on the actual service with secret.
            3. Your serverless function can now return the response it got back to your React front-end.

            Source https://stackoverflow.com/questions/62240661

            Community Discussions, Code Snippets contain sources that include Stack Exchange Network

            Vulnerabilities

            No vulnerabilities reported

            Install github-pages-deploy-action

            You can include the action in your workflow to trigger on any event that GitHub actions supports. If the remote branch that you wish to deploy to doesn't already exist the action will create it for you. Your workflow will also need to include the actions/checkout step before this workflow runs in order for the deployment to work. If you intend to make multiple deployments in quick succession you may need to leverage the concurrency parameter in your workflow to prevent overlaps.
            If you're using a custom domain and require a CNAME file, or if you require the use of a .nojekyll file, you can safely commit these files directly into the deployment branch without them being overridden after each deployment, additionally, you can include these files in your deployment folder to update them. If you need to add additional files to the deployment that should be ignored by the build clean-up steps you can utilize the clean-exclude option. If you wish to remove these files you must go into the deployment branch directly to remove them. This is to prevent accidental changes in your deployment script from creating breaking changes.

            Support

            This action is primarily developed using Ubuntu. In your workflow job configuration it's recommended to set the runs-on property to ubuntu-latest. If you're using an operating system such as Windows you can workaround this using artifacts. In your workflow configuration you can utilize the actions/upload-artifact and actions/download-artifact actions to move your project built on a Windows job to a secondary job that will handle the deployment.
            Find more information at:

            Find, review, and download reusable Libraries, Code Snippets, Cloud APIs from over 650 million Knowledge Items

            Find more libraries
            Install
          • npm

            npm i github-pages-deploy-action

          • CLONE
          • HTTPS

            https://github.com/JamesIves/github-pages-deploy-action.git

          • CLI

            gh repo clone JamesIves/github-pages-deploy-action

          • sshUrl

            git@github.com:JamesIves/github-pages-deploy-action.git

          • Stay Updated

            Subscribe to our newsletter for trending solutions and developer bootcamps

            Agree to Sign up and Terms & Conditions

            Share this Page

            share link

            Explore Related Topics

            Consider Popular Continous Integration Libraries

            chinese-poetry

            by chinese-poetry

            act

            by nektos

            volkswagen

            by auchenberg

            phpdotenv

            by vlucas

            watchman

            by facebook

            Try Top Libraries by JamesIves

            fetch-api-data-action

            by JamesIvesTypeScript

            github-sponsors-readme-action

            by JamesIvesTypeScript

            discord-wow-armory-bot

            by JamesIvesPython

            front-end-visual-comparison-tool

            by JamesIvesJavaScript

            discord-webhooks

            by JamesIvesPython