search

opengeospatial / CoverageJSON

Public repo for CoverageJSON project
Apache License 2.0
10 stars 8 forks source link

Set-up continuous integration to publish drafts to GitHub Pages #75

Closed letmaik closed 2 years ago

letmaik commented 2 years ago

Suggested in https://github.com/opengeospatial/CoverageJSON/issues/66#issuecomment-1126924912:

Set-up GitHub Actions on this repo to publish the latest commit to master to GitHub pages to https://opengeospatial.github.io/CoverageJSON/draft.html or similar. This will help spot outstanding issues during editing/development.

Dependencies: #73 and possibly #74.

chris-little commented 2 years ago

@ghobona Are you happy with this and alignment with OGC publishing procedures with Ribose? We want to be able to generate latest drafts automatically. We failed to get that to work over the last year with API EDR.

ghobona commented 2 years ago

@chris-little As of earlier this month, we now have a prototype GitHub Action that we can use to build OGC metanorma-asciidoc documents. The action is currently configured to build a document once a day but can be modified to use other triggers. There are some checks that metanorma does during the build process, however there are other checks that we would like to implement in the future. The prototype, when complete, will offer checks for conformance to OGC-NA policies.

ghobona commented 2 years ago

Cc: @ronaldtse @gbuehler

letmaik commented 2 years ago

@ghobona Keep in mind this project would benefit from CI now. This means either it is converted to the new Metanorma template first to be able to use the mentioned GitHub Actions, or a custom setup is done. Which do you suggest?

ghobona commented 2 years ago

The GitHub Action has been created at https://github.com/opengeospatial/CoverageJSON/blob/master/.github/workflows/generate_21-069.yml

The PDF and HTML documents are placed in the root folder of the repository.

ghobona commented 2 years ago

Based on the feedback at https://github.com/opengeospatial/CoverageJSON/pull/79 , I have moved the GitHub Action to a separate repository.

The autogenerated HTML file will now be placed there, so will not interfere with commits in the CoverageJSON repository.

If the CoverageJSON group would like to propose an alternative approach, we are happy to discuss it.

letmaik commented 2 years ago

Thanks @ghobona, I think this is a better solution. I think long term, once the reusable OGC/Metanorma GitHub Action reaches a stable state, it would be preferable to have the action in the CoverageJSON repository itself, to avoid the 1-day delay between commit and HTML update. Do you agree?

chris-little commented 2 years ago

@ghobona @jonblower @letmaik Proposed standard and current working draft now set up, so agreed to close at 2022-05-25 Task Team meeting