Overview:

The jekyll-update-pages-action is a GitHub action that allows users to update one or more repositories with GitHub Pages enabled without generating a new commit. It provides a convenient way to automate the update process for GitHub Pages sites.

Features:

• Update Multiple Repos: The action allows users to update multiple repositories at once, saving time and effort.
• Scheduled Updates: Users can schedule the action to run at a specific time or interval, making it easy to keep GitHub Pages sites up to date.
• Personal Access Token: The action requires a personal access token for accessing the GitHub API, ensuring secure and authorized updates.

Installation:

To install the jekyll-update-pages-action, follow the steps below:

1. Create a personal access token:

   • Go to your GitHub account settings.
   • Navigate to the “Developer settings” tab.
   • Click on “Personal access tokens”.
   • Generate a new token with the necessary permissions.

2. Choose search filters:

   • Determine the filters you want to use to find the repositories to update.
   • Encode the filter query to be used as an input.

3. Add the action to your workflow file:

   • Create or open the workflow file where you want to use the action.
   • Add the following code snippet to your workflow file:

   - name: Update GitHub Pages
     uses: dp6/jekyll-update-pages-action@v1
     with:
       DEPLOY_TOKEN: ${{/* secrets.DEPLOY_TOKEN */}}
       USER: ${{/* secrets.USER */}}
       FILTER: ${{/* secrets.FILTER */}}
   

4. Replace the variables in the code snippet with the appropriate values.

5. Save and commit the changes to the workflow file.

Summary:

The jekyll-update-pages-action is a powerful GitHub action that simplifies the process of updating repositories with GitHub Pages enabled. It allows for bulk updates, scheduled updates, and requires a personal access token for secure access to the GitHub API. By automating the update process, users can easily keep their GitHub Pages sites up to date without the need for manual commits.