Giter Club home page Giter Club logo

panda-watcher-ci's Introduction

Panda-watcher-CI

Panda watcher CI is a Github Action CI workflow script that complements panda-portfolio. It automates the task of building static html from config.json file.

Introduction

Panda watcher CI is a complemetary script to Panda-portfolio. It automatically runs npx panda-portfolio config.json, builds static html from config.json, pushes it to the branch and requests page rebuild (in case of github pages).

Features

  • Autogenerate static html page when pushed changes to repo
  • Requests gh-pages rebuild to deploy new site
  • Easy to use and implement

Usage

  1. Generate Personal Authentication Token (Why do I need this?)

    1. In the upper-right corner of any page, click your profile photo, then click Settings.
    2. In the left sidebar, click Developer settings.
    3. In the left sidebar, click Personal access tokens.
    4. Click Generate new token.
    5. Give your token name PAT_TOKEN.
    6. Select repo scope.
    7. Click Generate Token.
    8. Click to copy the token to your clipboard. For security reasons, after you navigate off the page, you will not be able to see the token again.
  2. Go to repo where panda-watcher-CI is configured. Add PAT to repository secret.

    1. Go to Settings > Add new secrets Step 1
    2. Click on Add a new secret
    3. Give the title PAT_TOKEN, and paste the token from Step 2 in value Step 2
    4. Click on Add Secret Step 3
  3. Copy main.yml to .github/workflows in the target repo.

  4. You are ready to go.

See demo

See demo on https://github.com/bhumijgupta/bhumijgupta.github.io/

Why generate PAT token

Panda-watcher-CI adds an additional commit to the repo. We add commit from a dummy account ([email protected]). Github Actions does not run when additional commit is added from dummy account. This also does not trigger Github pages to rebuild the page. To rebuild the page we trigger Github pages API to rebuild the page, which requires the PAT token.

License

GitHub

This library is licensed under MIT License. The license file can be found here

Author

forthebadge

Bhumij Gupta

GitHub followers LinkedIn Twitter URL


if(repo.isAwesome || repo.isHelpful){
    StarRepo();
}

panda-watcher-ci's People

Contributors

bhumijgupta avatar

Watchers

 avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.