Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add a workflow for a doc update on gh-pages branch for pushes to develop #192

Merged
merged 10 commits into from
Jul 18, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 0 additions & 5 deletions .github/workflows/developer.yml
Original file line number Diff line number Diff line change
Expand Up @@ -133,9 +133,6 @@ jobs:
path: ~/data
key: data-2

- name: Setup Pages
uses: actions/configure-pages@v4

- name: build
run: |
cd wgrib2
Expand Down Expand Up @@ -168,6 +165,4 @@ jobs:
with:
path: wgrib2/build/docs/html # Path to the built site files

- name: Deploy
uses: actions/deploy-pages@v1

105 changes: 105 additions & 0 deletions .github/workflows/docs.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,105 @@
# This workflow builds the docs and uploads them to gh-pages branch
# for the wgrib2 project.
#
# Ed Hartnett
name: docs
on:
push:
branches:
- develop

# Cancel in-progress workflows when pushing to a branch
concurrency:
group: ${{ github.workflow }}-${{ github.event.pull_request.number || github.ref }}
cancel-in-progress: true

jobs:
docs:
runs-on: ubuntu-latest
env:
FC: gfortran
CC: gcc

permissions:
id-token: write
pages: write

steps:

- name: install
run: |
sudo apt-get update
sudo apt-get install libnetcdf-dev libnetcdff-dev netcdf-bin pkg-config
sudo apt-get install libpng-dev autotools-dev libaec-dev autoconf gcovr doxygen

- name: cache-jasper
id: cache-jasper
uses: actions/cache@v4
with:
path: ~/jasper
key: jasper-${{ runner.os }}-1.900.1

- name: checkout-jasper
if: steps.cache-jasper.outputs.cache-hit != 'true'
uses: actions/checkout@v4
with:
repository: jasper-software/jasper
path: jasper
ref: version-1.900.1

- name: build-jasper
if: steps.cache-jasper.outputs.cache-hit != 'true'
run: |
cd jasper
./configure --prefix=$HOME/Jasper
make
make install

- name: checkout-ip
uses: actions/checkout@v4
with:
repository: NOAA-EMC/NCEPLIBS-ip
path: ip
ref: v5.0.0

- name: build-ip
run: |
cd ip
mkdir build
cd build
cmake .. -DCMAKE_INSTALL_PREFIX=~/ip
make -j2
make install

- name: checkout
uses: actions/checkout@v4
with:
path: wgrib2

- name: cache-data
id: cache-data
uses: actions/cache@v4
with:
path: ~/data
key: data-2

- name: Setup Pages
uses: actions/configure-pages@v4

- name: build
run: |
cd wgrib2
mkdir build
cd build
cmake .. -DENABLE_DOCS=ON -DCMAKE_PREFIX_PATH="~/ip"
make VERBOSE=1

- name: Upload built documentation
uses: actions/upload-pages-artifact@v1
with:
path: wgrib2/build/docs/html # Path to the built site files

- name: Deploy
uses: actions/deploy-pages@v1


3 changes: 2 additions & 1 deletion docs/user_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

# Introduction

This document briefly describes wgrib2.
This document briefly describes wgrib2, which provides functionality
for interacting with, reading, writing, and manipulating GRIB2 files.

## Documentation for Previous Versions of wgrib2

Expand Down
Loading