Skip to content

Commit c31654f

Browse files
Ivoid service (#3)
* ivoid_service matches with astropy * Markus review + details * Markus suggestions * editorial review * review example * Update build.yml * Provenance review * ci update * dd figure (in pdf) * M.Servillat ack
1 parent 6443618 commit c31654f

File tree

16 files changed

+232
-2886
lines changed

16 files changed

+232
-2886
lines changed

.github/workflows/build.yml

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,10 @@ jobs:
2828
- name: Setup dependencies
2929
run: |
3030
sudo apt update
31-
sudo apt install texlive-latex-base texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended xsltproc latexmk cm-super texlive-extra-utils
31+
sudo apt install texlive-latex-base texlive-latex-recommended \
32+
texlive-latex-extra texlive-fonts-recommended \
33+
librsvg2-bin latexmk \
34+
pdftk xsltproc latexmk cm-super
3235
3336
- name: Build the document
3437
run: make
@@ -39,7 +42,7 @@ jobs:
3942
test -f ${{ env.doc_name }}.bbl
4043
4144
- name: Keep the PDF artefact
42-
uses: actions/upload-artifact@v1
45+
uses: actions/upload-artifact@v4
4346
with:
4447
name: PDF Preview
4548
path: ${{ env.doc_name }}.pdf

.github/workflows/preview.yml

Lines changed: 33 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,9 @@
77
name: Update PDF Preview
88

99
env:
10-
doc_name: data-origin
10+
doc_name : data-origin
11+
branch_name: ${{ github.head_ref || github.ref_name }}
12+
tag_preview: auto-pdf-preview
1113

1214
on:
1315
push:
@@ -22,15 +24,17 @@ jobs:
2224
steps:
2325

2426
- name: Checkout the repository
25-
uses: actions/checkout@v1
27+
uses: actions/checkout@v4
2628
with:
2729
submodules: true
2830

2931
- name: Setup dependencies
3032
run: |
3133
sudo apt update
32-
sudo apt install texlive-latex-base texlive-latex-recommended texlive-latex-extra texlive-fonts-recommended xsltproc latexmk cm-super texlive-extra-utils
33-
sudo snap install pdftk
34+
sudo apt install texlive-latex-base texlive-latex-recommended \
35+
texlive-latex-extra texlive-fonts-recommended \
36+
librsvg2-bin latexmk \
37+
pdftk xsltproc latexmk cm-super
3438
3539
- name: Build the document
3640
run: make ${{ env.doc_name }}-draft.pdf
@@ -40,27 +44,31 @@ jobs:
4044
test -f ${{ env.doc_name }}-draft.pdf
4145
test -f ${{ env.doc_name }}.bbl
4246
43-
- name: Move the auto-pdf-preview tag
44-
uses: weareyipyip/walking-tag-action@v2
45-
with:
46-
tag-name: auto-pdf-preview
47-
tag-message: |
48-
Last commit taken into account for the automatically updated PDF preview of this IVOA document.
47+
- name: Remove the former PDF preview (if any)
48+
run: |
49+
existingTag=$( gh release list --exclude-drafts --json 'isPrerelease,tagName' \
50+
--jq '.[] | select(.isPrerelease == true and .tagName == "${{ env.tag_preview }}") | .tagName' \
51+
| xargs -n 1 echo )
52+
if [ -n "$existingTag" ];
53+
then
54+
gh release delete --cleanup-tag "$existingTag"
55+
fi
4956
env:
50-
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
57+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
5158

52-
- name: Update the PDF preview
53-
uses: Xotl/cool-github-releases@v1
54-
with:
55-
mode: update
56-
isPrerelease: true
57-
tag_name: auto-pdf-preview
58-
release_name: "Auto PDF Preview"
59-
body_mrkdwn: |
60-
This release aims to provide a PDF preview of the last commit applied on this repository.
59+
- name: Upload the new PDF preview
60+
run: |
61+
RELEASE_NOTES="This release aims to provide a PDF preview of the last commit applied on this repository.
6162
It will be updated automatically after each merge of a PullRequest.
62-
**DO NOT PUBLISH THIS PRE-RELEASE!**"
63-
_Corresponding commit: ${{ github.sha }}_
64-
assets: ${{ env.doc_name }}-draft.pdf
65-
replace_assets: true
66-
github_token: ${{ secrets.GITHUB_TOKEN }}
63+
**DO NOT PUBLISH THIS PRE-RELEASE!**
64+
_Corresponding commit: ${{ github.sha }}_"
65+
66+
gh release create ${{ env.tag_preview }} \
67+
${{ env.doc_name }}-draft.pdf \
68+
--prerelease \
69+
--target "${{ env.branch_name }}" \
70+
--title 'Auto PDF Preview' \
71+
--notes "$RELEASE_NOTES"
72+
env:
73+
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
74+

README.md

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,6 @@ The following metadata can be repeated and could follow a controlled vocabulary.
7979

8080
- Author: name or ORCID
8181
- Organization: name or URL
82-
- Editor: name or URL
8382
- Journal: name or URL
8483
- Datacenter that provides the result: name or URL
8584
- Contact: email
@@ -115,7 +114,6 @@ For queries on evolving dataset, the version or the date must complete the infor
115114
|version | Dataset version (or release date) | |
116115
|service_protocol| Protcol access with version | |
117116
|request| Request url  | |
118-
|request_post| (POST Request) POST arguments **new**  | |
119117
|request_date| Query execution date | |
120118
|contact| email or URL contact | |
121119
|landing_page| Dataset landing page | |
@@ -133,12 +131,11 @@ Dataset-origin completes the "Query information" -
133131
|Publication-id| Dataset identifier that can be used for citation | yes |
134132
|Curation-level| Controled vocabulary | |
135133
|Resource-version| Dataset version od last release | |
136-
|Rights| Licence URI | |
137-
|Rights-type| Licence type (eg: CC-by, CC-0, private, public) | |
138-
|Copyrights| Copyright text | |
134+
|Rights_URI| Licence URI | |
135+
|Rights| Licence type (eg: CC-by, CC-0, private, public) or copyrights| |
139136
|Creator| Dataset Author(s) or group | |
140137
|Publication-ref| Identifier of the original resource that can be an article or the origin Data Center|
141-
|Editor| editor name| |
138+
|Journal or Editor| journal or editor name| |
142139
|Relation_type | controled vocabulary (VOResource: relationshipType ? ) to specify relation to related resource **new**|
143140
|related_resource | Original resource **new**|
144141
|Publication-date| Date of the original publication | |
@@ -152,33 +149,6 @@ eg: bibcode:...,
152149
Serialisation example: &lt;info&gt; tag makes the jobs. see <a href='tests/J_AJ_161_36_table8.xml'>SCS example</a>
153150

154151

155-
- Complex output involving **several tables** (eg: TAP query, ObsCore result)
156-
157-
Dataset-origin depends on each table used for the output. Datamodels like Last-step -Provenance or DatasetDM allows to gather the metadata.
158-
159-
DatasetDM Example:
160-
161-
|meta-data| Description| Mandatory |
162-
|--- |:-: |:-: |
163-
|dataset:productType|||
164-
|dataset:productSubType| controled vocabulary||
165-
|dataset:DataID.datasetDID| dataset ivoid|yes|
166-
|dataset:DataID.title| dataset title||
167-
|dataset:DataID.creationType| type of resource ||
168-
|dataset:DataID.date| Publication date of original dataset/article||
169-
|dataset:Party.name| (first)Author | |
170-
|dataset:Curation.publisherDID| data-center identifier (ivoid)|yes|
171-
|dataset:Curation.rights| rights text| |
172-
|dataset:Curation.releaseDate| Data-center publication date|yes|
173-
|party.Organisation.email|Data-center contact||
174-
|dataset:Curation.doi| Dataset DOI| |
175-
|dataset:Curation.bibcode| Dataset bibcode||
176-
177-
Serialisation example: DatasetDM serialisation. see <a href='tests/tap.xml'>TAP example</a>
178-
179-
(see also: <a href='https://wiki.ivoa.net/twiki/pub/IVOA/InterOpOct2022DM/IVOA-DMTAP-VizieR.pdf'>datasetDM in TAP (ivoa-talk)</a>
180-
181-
182152

183153
# About
184154
This document describes simple means to declare basic provenance

0 commit comments

Comments
 (0)