update-gh-pages

This GitHub action updates (or creates) the gh-pages branch of a GAP package using GitHubPagesForGAP.

Caution

By default this action regenerates the gh-pages branch of your repository from scratch. If you made custom modifications to that branch, you need to disable this behavior by setting the clean input to false.

Usage

The action update-gh-pages has to be called by the workflow of a GAP package. By default, it will use the latest release of the package.

Inputs

All of the following inputs are optional.

• version:
  • Set to a non-empty string to choose a specific release of your package (e.g. v1.2.3) instead of the latest release.
  • default: ''
• clean:
  • Set to false to only update the information on the website and not the website code itself. This can be useful if you have made modifications to it.
  • default: true
• dry-run:
  • Set to true to create an archive containing the website instead of pushing to the gh-pages branch.
  • default: false
• extra-files:
  • Set to a non-empty string to specify files and directories to copy from the package repository to the website.
  • The string should be comma-separated list of colon-separated pairs of files and/or directories of the form source:destination to be copied from the package to the gh-pages branch (relative to the root directory, in both cases).
    • For example, setting the extra-files option to d1/f1:D1/F1,d2:D2/D3 will copy the file d1/f1 and the directory d2, respectively, from the package repository to the file D1/F2 and to the directory D2/D3/ of the gh-pages branch, creating new directories as necessary.
    • For example, setting the extra-files option to CHANGES.md,help/README-extra.md will copy the files CHANGES.md and help/README-extra.md from the package repository to the gh-pages branch with the same names and path structures.

Example

See below for a minimal example to run this action.

Minimal example

name: Update GH-pages
on:
  workflow_dispatch:

permissions: write-all

jobs:
  update:
    name: Update GH pages
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v5
      - uses: gap-actions/setup-gap@v2
      - uses: gap-actions/update-gh-pages@v1

Example with inputs

name: Update GH-pages
on:
  workflow_dispatch:
    inputs:
      version:
        description: 'Set to a non-empty string to choose a specific release of your package'
        required: false
        type: string
        default: ''
      clean:
        description: 'Set to false to only update the information on the website and not the website code itself'
        required: false
        type: boolean
        default: true
      dry-run:
        description: 'Set to true to create an archive containing the website instead of pushing to the gh-pages branch'
        required: false
        type: boolean
        default: false
      extra-files:
        description: 'A comma-separated list of colon-separated pairs of files and/or directories to be copied from the package to the gh-pages branch'
        required: false
        type: string
        default: ''

permissions: write-all

jobs:
  update:
    name: Update GH pages
    runs-on: ubuntu-latest

    steps:
      - uses: actions/checkout@v5
      - uses: gap-actions/setup-gap@v2
      - uses: gap-actions/update-gh-pages@v1
        with:
          version: ${{ inputs.version }}
          clean: ${{ inputs.clean }}
          dry-run: ${{ inputs.dry-run }}

Contact

Please submit bug reports, suggestions for improvements and patches via the issue tracker.

License

The action update-gh-pages is free software; you can redistribute and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your opinion) any later version. For details, see the file LICENSE distributed with this action or the FSF's own site.