diff --git a/.github/workflows/test_build.yml b/.github/workflows/test_build.yml new file mode 100644 index 00000000..7268d858 --- /dev/null +++ b/.github/workflows/test_build.yml @@ -0,0 +1,27 @@ +name: Build Jekyll site +on: + pull_request: + workflow_dispatch: + +jobs: + + build: + runs-on: ubuntu-latest + + permissions: + contents: write + pull-requests: write + + steps: + - name: Checkout + uses: actions/checkout@v7 + - name: Setup Pages + uses: actions/configure-pages@v6 + - name: Build + uses: actions/jekyll-build-pages@v1 + - name: Upload artifact + uses: actions/upload-pages-artifact@v5 + with: + retention-days: 14 + + diff --git a/README.md b/README.md index 7c7a8cd1..b46c7938 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,20 @@ In order to edit this file, you can: * (advanced) edit the CSS style files: `_sass/_variables.scss` or `_sass/_bootstrap_customization.scss` +## CI Testing of File Rendering + +(see below for local testing) + +When a pull request (PR) is submitted for this repository, an action will automatically attempt to build the +pages and upload an artifact of that process as part of the test, named `github-pages`. The artifact can be +found by viewing the results of the test, clicking on the “Summary” and scrolling to the bottom of the page. + +To view the result of the pages you can: +* download the artifact +* unzip the file +* change to the folder that is created +* run `python3 -m http.server` and open the location on your browser, usually `localhost:8000` + ## Local testing of file rendering In order to test the rendering of the files, you can run a local Jekyll server