search

sasaki77 / archiverappliance-datasource

EPICS Archiver Appliance plugin for Grafana dashboard
https://sasaki77.github.io/archiverappliance-datasource
MIT License
14 stars 7 forks source link

Automate documentation building on tags #28

Closed n-wbrown closed 3 years ago

n-wbrown commented 3 years ago

This PR adds documentation generation and posting to the publish-release.yml CI script. Documentation will be pushed to the gh-pages branch whenever a new tag is pushed to the GitHub repository.

Discussion is welcome.

sasaki77 commented 3 years ago

Thanks! These look like good.

This CI only works for release stage, right? At times, I'd like to update documentation without publishing release.

Could you create a new CI flow for documentations build? The CI should run only if there are some changes in docs/**.

Can we do that like below?

on:
  push:
    paths:
    - 'docs/**'
n-wbrown commented 3 years ago

I've separated the documentation building into a separate script. Do you think it would make sense to constrain the documentation-building job to pushes to the master/main branch or is it better to leave it available for all branches?

sasaki77 commented 3 years ago

Thank you for the updating! I think it would be better that the job runs only if we push to the master/main branch.

n-wbrown commented 3 years ago

I've added the restriction to master/main. Additionally, in case we ever need it, there's a workflow_dispatch option which should allow us to prompt the script from the github actions interface.

sasaki77 commented 3 years ago

It looks good to me. Thanks!