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

Move endpoints to txt files (#10) #11

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

salvafern
Copy link
Contributor

Explained in #10

Hi @tim-collart

Question coming from EMODnet/emodnet.wfs#139

Would you agree with turning the tables in the README containing the endpoints for WFS etc into csv or other tabulated file format?

Reason:
The most up-to-date place where the endpoints of EMODnet are seems to be this repo. We (me and @maelle ) could not figure out how to get such an updated list from geonetwork (See EMODnet/emodnet.wfs#129 (comment)).

We know that eventually geonetwork will be the best place to get such a list, but for the time being we are struggling to keep up with updated services as we are normally not notified of any change, hence we only get to know via CI/CD errors in the EMODnetWFS repo. Which is quite frustrating tbh.

Proposal:
If you agreed I would suggest one of these ideas to read the csv file with the endpoints

Turn the README into a RMarkdown document (currently plain markdown). Read the file as a data frame and knit to a markdown document.
Use a github action that turns the csv into a markdown table and injects into the README.md with every commit.

Thanks in advance and let me know you agree. Happy to give it a try and do a PR.

  • I created a few tab separated txt files added to a new dir data/ with the enpoints.
  • I also created a README.Rmd file that can be knitted to the README.md doc. It reads the txt files and prints as markdown tables.
  • Whenever an endpoint change, this needs to be done in the txt file and the README.Rmd needs to knitted to README.md. In return, we can read these txt files programatically e.g. in EMODnetWFS

cc @maelle

@salvafern salvafern added the enhancement New feature or request label Apr 6, 2023
@salvafern salvafern requested a review from tim-collart April 6, 2023 10:24
@salvafern salvafern self-assigned this Apr 6, 2023
@maelle
Copy link

maelle commented Apr 6, 2023

@salvafern I went ahead and added a GitHub Actions workflow that automatically knits the README if README.Rmd or data/ have changes; or with a manual trigger. It's inspired by the one rOpenSci software-review uses https://github.com/ropensci/software-review/blob/main/.github/workflows/main.yml

Since this repository was created before February, things should just work (for later repos, this change https://github.blog/changelog/2023-02-02-github-actions-updating-the-default-github_token-permissions-to-read-only/ means a setting would need to be tweaked to allow GHA to commit)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants