mirror of
https://github.com/CoolProp/CoolProp.git
synced 2026-01-13 16:08:09 -05:00
522e810574
- Streamlined the build of the HTML documentation based on a private docker image. - Invoke doxygen and Sphinx to create the final HTML pages. - Employ a cache for the GitHub actions to store the output of the expensive tasks. - Restructured the GitHub actions builders and introduced a naming scheme. - Fixed a few typos in the docs. - Automatically publish the documentation to GitHub pages.
58 lines
1.7 KiB
YAML
58 lines
1.7 KiB
YAML
# This workflow uses actions that are not certified by GitHub.
|
|
# They are provided by a third-party and are governed by
|
|
# separate terms of service, privacy policy, and support
|
|
# documentation.
|
|
|
|
# GitHub recommends pinning actions to a commit SHA.
|
|
# To get a newer version, you will need to update the SHA.
|
|
# You can also reference a tag or branch, but the action may change without warning.
|
|
|
|
name: Documentation Docker image
|
|
|
|
on:
|
|
workflow_dispatch:
|
|
push:
|
|
branches: [ 'master', 'main', 'develop', 'actions_docs' ]
|
|
tags: [ 'v*' ]
|
|
pull_request:
|
|
branches: [ 'master', 'main', 'develop' ]
|
|
|
|
env:
|
|
REGISTRY: ghcr.io
|
|
IMAGE_SUFFIX: docs_01_base
|
|
IMAGE_NAME: ${{ github.repository }}
|
|
|
|
jobs:
|
|
build:
|
|
runs-on: ubuntu-latest
|
|
permissions:
|
|
contents: read
|
|
packages: write
|
|
|
|
steps:
|
|
- name: Checkout repository
|
|
uses: actions/checkout@v3
|
|
|
|
- name: Log in to the Container registry
|
|
uses: docker/login-action@v2
|
|
with:
|
|
registry: ${{ env.REGISTRY }}
|
|
username: ${{ github.actor }} # This uses the permissions of the user who triggered the workflow
|
|
password: ${{ secrets.GITHUB_TOKEN }}
|
|
|
|
- name: Extract metadata (tags, labels) for Docker
|
|
id: meta
|
|
uses: docker/metadata-action@v4
|
|
with:
|
|
images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}_${{ env.IMAGE_SUFFIX }}
|
|
|
|
- name: Build and push Docker image
|
|
uses: docker/build-push-action@v3
|
|
with:
|
|
context: ./dev/docker/
|
|
file: ./dev/docker/${{ env.IMAGE_SUFFIX }}.Dockerfile
|
|
push: ${{ github.event_name != 'pull_request' }}
|
|
#tags: ${{ steps.meta.outputs.tags }},dev
|
|
tags: dev
|
|
labels: ${{ steps.meta.outputs.labels }}
|