Re: [CF-metadata] [cf-convention/cf-conventions] Single-source the version number (Issue #343)

2022-01-07 Thread Klaus Zimmermann
Re workflow, that was exactly my thinking. I have added this now to #344.

Re removing the attribute from the examples, I am not so sure. I think we 
should probably consider categorizing examples in the conventions as either 
"full examples" or "simple examples"/"excerpts" and then rather add the 
attribute to all full examples and possibly some excerpts as appropriate. My 
reasoning is that I think many first time producers of data files will follow 
closely some examples and if we leave out this attribute, they might too.
But perhaps this deserves a separate discussion.

Re @ethanrd's comment on the naming of the attribute, I completely agree, 
`attribute-version` is not very clear. How about `current-version-in-attribute` 
or `current-version-for-attribute`?

-- 
Reply to this email directly or view it on GitHub:
https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/issues/343*issuecomment-1007607710__;Iw!!G2kpM7uM-TzIFchu!mk8WbnPulon2XXFw6vehZDdcM_QxE8pWmekxh3EM_MPW-_B4pA9_jibp9QVkA2nzA29MeZ_adao$
 
You are receiving this because you are subscribed to this thread.

Message ID: 
This list forwards relevant notifications from Github.  It is distinct from 
cf-metad...@cgd.ucar.edu, although if you do nothing, a subscription to the 
UCAR list will result in a subscription to this list.
To unsubscribe from this list only, send a message to 
cf-metadata-unsubscribe-requ...@listserv.llnl.gov.


Re: [CF-metadata] [cf-convention/cf-conventions] Single source version (PR #344)

2022-01-07 Thread Klaus Zimmermann
@zklaus pushed 2 commits.

b5f746651571405b02008cbddc5ea04659fcd47b  Correct typos and trailing whitespace 
in workflow
ef00c0dc1484f1404cd65dc59c549a2ae72edc84  Add automatic final versioning to 
workflow


-- 
View it on GitHub:
https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/pull/344/files/ff0a539a242555b27cd6aa5018e6e9a0c65b1530..ef00c0dc1484f1404cd65dc59c549a2ae72edc84__;!!G2kpM7uM-TzIFchu!nlbI9umPRbLIqXF9L9Tyw7xTkLZutdHWXlwEVUjJn49va9tgPmMNXx3BnXqGZoHHTJx1Cklz2yM$
 
You are receiving this because you are subscribed to this thread.

Message ID: 

This list forwards relevant notifications from Github.  It is distinct from 
cf-metad...@cgd.ucar.edu, although if you do nothing, a subscription to the 
UCAR list will result in a subscription to this list.
To unsubscribe from this list only, send a message to 
cf-metadata-unsubscribe-requ...@listserv.llnl.gov.


Re: [CF-metadata] [cf-convention/cf-conventions] Cutting version 1.10 (Issue #345)

2022-01-07 Thread Klaus Zimmermann
Perhaps my previous comment was a bit obtuse. With regards to @erget's and 
@davidhassell's comments
> [Daniel 
> wrote](https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/issues/345*issuecomment-1006644633__;Iw!!G2kpM7uM-TzIFchu!m-BEKDNGskMuc_Oe2W9Abw9PsFrtTgIzNuOlrIIzIA0KvWRrfXFElemlYoDqEWbHGY6CDC8b_TE$
>  ):
> > Barring that, this can be discovered by pulling up closed PRs and sorting 
> > by date, then checking what was merged into main between releases - that is 
> > however more laborious, so labeling the PRs pre-merge would be the most 
> > expedient in my view.
>
> That is exactly what I did when applying many of those milestones - and it 
> was indeed laborious. Labelling them at merge-time would be a great addition 
> to the workflow.

I wanted to point out that this process can and should be automatized using the 
github api. It is really only a few lines of code (the changelog script I 
referenced above is less than 200 lines and includes formatting and filtering).

With this, the task won't be laborious anymore.

-- 
Reply to this email directly or view it on GitHub:
https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/issues/345*issuecomment-1007593004__;Iw!!G2kpM7uM-TzIFchu!m-BEKDNGskMuc_Oe2W9Abw9PsFrtTgIzNuOlrIIzIA0KvWRrfXFElemlYoDqEWbHGY6Cw67emew$
 
You are receiving this because you are subscribed to this thread.

Message ID: 
This list forwards relevant notifications from Github.  It is distinct from 
cf-metad...@cgd.ucar.edu, although if you do nothing, a subscription to the 
UCAR list will result in a subscription to this list.
To unsubscribe from this list only, send a message to 
cf-metadata-unsubscribe-requ...@listserv.llnl.gov.


Re: [CF-metadata] [cf-convention/cf-conventions] Single-source the version number (Issue #343)

2022-01-07 Thread Ethan Davis
It took me awhile to understand the meaning of the term `attribute-version`. 
Perhaps `current-version-as-attribute`?

I like the definitive nature of updating the version from `1.10-draft` to 
`1.10` for release and then immediately updating to `1.11-draft`. It leaves an 
artifact (source zip file) that is clearly marked as a full release. On the 
other hand, this is a documentation project not a software project and we 
distribute document artifacts not source artifacts. However, it might be more 
of an issue depending on where the CF DOI conversation about version specific 
DOIs goes.


-- 
Reply to this email directly or view it on GitHub:
https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/issues/343*issuecomment-1007587182__;Iw!!G2kpM7uM-TzIFchu!itXafRG3RTx6TTruC04c6mYK8PUHq8wrIPEwQR7qCkUMJZS8G8Txe825ye7H3aq9q7X2kyP_juE$
 
You are receiving this because you are subscribed to this thread.

Message ID: 
This list forwards relevant notifications from Github.  It is distinct from 
cf-metad...@cgd.ucar.edu, although if you do nothing, a subscription to the 
UCAR list will result in a subscription to this list.
To unsubscribe from this list only, send a message to 
cf-metadata-unsubscribe-requ...@listserv.llnl.gov.


Re: [CF-metadata] [cf-convention/cf-conventions] Cutting version 1.10 (Issue #345)

2022-01-07 Thread David Hassell
Dear Jonathan,

You can see the milestone, but it's easy to miss, as it's not formatted the 
same as a label:

![image](https://urldefense.us/v3/__https://user-images.githubusercontent.com/8126576/148561188-939c9fbc-0624-4cf0-ac9a-a1822360cbf9.png__;!!G2kpM7uM-TzIFchu!ky5eQLERB8oJzQOTQu2EfIrbmm2NkdHA17BA3OuxDvRuA4t4V_DD3Y1NHSwqKA_I8xq_U8shMYo$
 )

The proposed "Change agreed" label is still a good idea, in addition to the 
milestone.

-- 
Reply to this email directly or view it on GitHub:
https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/issues/345*issuecomment-1007469405__;Iw!!G2kpM7uM-TzIFchu!ky5eQLERB8oJzQOTQu2EfIrbmm2NkdHA17BA3OuxDvRuA4t4V_DD3Y1NHSwqKA_I8xq_g8zj-qA$
 
You are receiving this because you are subscribed to this thread.

Message ID: 
This list forwards relevant notifications from Github.  It is distinct from 
cf-metad...@cgd.ucar.edu, although if you do nothing, a subscription to the 
UCAR list will result in a subscription to this list.
To unsubscribe from this list only, send a message to 
cf-metadata-unsubscribe-requ...@listserv.llnl.gov.


Re: [CF-metadata] [cf-convention/cf-conventions] Single-source the version number (Issue #343)

2022-01-07 Thread JonathanGregory
Dear @zklaus 

As @adigitoleo says, there are no examples in the document which contain the 
`Conventions` attribute except in sect 7.5 (examples 7.15 and 7.16). Therefore 
I'd suggest you _delete_ the `Conventions` attribute in those two examples, 
instead of correcting it. It's not necessary (now that 7.5 is an established 
part of the conventions).

Best wishes

Jonathan

-- 
Reply to this email directly or view it on GitHub:
https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/issues/343*issuecomment-1007411080__;Iw!!G2kpM7uM-TzIFchu!icrPTrMgqI711cha1xI-Zs6DJ3I9IUM5dBVFP1WiraBinvCqQhcKQ57kPmbw5jw6ICgVwhdCXhk$
 
You are receiving this because you are subscribed to this thread.

Message ID: 
This list forwards relevant notifications from Github.  It is distinct from 
cf-metad...@cgd.ucar.edu, although if you do nothing, a subscription to the 
UCAR list will result in a subscription to this list.
To unsubscribe from this list only, send a message to 
cf-metadata-unsubscribe-requ...@listserv.llnl.gov.


Re: [CF-metadata] [cf-convention/cf-conventions] Cutting version 1.10 (Issue #345)

2022-01-07 Thread Daniel Lee
We could always correct 1.9 using the procedure for errata so that 1.9 remains 
valid - leaving the error in 1.9 and minting a new release to correct it would 
be similar to deprecating 1.9, which would be new ground.

-- 
Reply to this email directly or view it on GitHub:
https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/issues/345*issuecomment-1007410745__;Iw!!G2kpM7uM-TzIFchu!hnL4EzBzlInfFn7ZOZCN7SvSHpKlGHX0f_ay_5sxkfKUK-6tWHT7CzmdIojNihuq95-wJrmHfvY$
 
You are receiving this because you are subscribed to this thread.

Message ID: 
This list forwards relevant notifications from Github.  It is distinct from 
cf-metad...@cgd.ucar.edu, although if you do nothing, a subscription to the 
UCAR list will result in a subscription to this list.
To unsubscribe from this list only, send a message to 
cf-metadata-unsubscribe-requ...@listserv.llnl.gov.


Re: [CF-metadata] [cf-convention/cf-conventions] Cutting version 1.10 (Issue #345)

2022-01-07 Thread JonathanGregory
Dear @davidhassell 

Thanks for explaining about milestones. As a test I have just attributed the 
[closed issue about lossy compression by coordinate 
sampling](https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/issues/327__;!!G2kpM7uM-TzIFchu!jKwQhdcB1F3gJcezSDgXZxVKmnZBKVAz1ut83Xn79F6kDlV_Fu8h3zyKHM8v_P-lgp58GQyNKXk$
 ) to milestone 1.9. That is obvious when you open the issue, but you don't see 
it in the list of issues or when hovering on the issue, so a label saying 
"Change agreed" would be separately useful still. You can also filter the 
issues as Daniel showed for PRs. [Filtering the closed issues for the 1.9 
milestone](https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/issues?q=is*3Aissue*is*3Aclosed*milestone*3A1.9__;JSslKyU!!G2kpM7uM-TzIFchu!jKwQhdcB1F3gJcezSDgXZxVKmnZBKVAz1ut83Xn79F6kDlV_Fu8h3zyKHM8v_P-lgp586HawF-U$
 ) now shows just the one I have tagged.

It's OK not to make a special release in order to fix this defect if we're sure 
there's not much danger of anyone coding `Conventions` as 1.8 instead of 1.9 
without thinking about it.

Cheers

Jonathan

-- 
Reply to this email directly or view it on GitHub:
https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/issues/345*issuecomment-1007408268__;Iw!!G2kpM7uM-TzIFchu!jKwQhdcB1F3gJcezSDgXZxVKmnZBKVAz1ut83Xn79F6kDlV_Fu8h3zyKHM8v_P-lgp58QfEEeXg$
 
You are receiving this because you are subscribed to this thread.

Message ID: 
This list forwards relevant notifications from Github.  It is distinct from 
cf-metad...@cgd.ucar.edu, although if you do nothing, a subscription to the 
UCAR list will result in a subscription to this list.
To unsubscribe from this list only, send a message to 
cf-metadata-unsubscribe-requ...@listserv.llnl.gov.


Re: [CF-metadata] [cf-convention/cf-conventions] Single-source the version number (Issue #343)

2022-01-07 Thread JonathanGregory
That's clever, @zklaus. Thanks. I agree with @erget, and I am not an expert on 
the build workflow.

-- 
Reply to this email directly or view it on GitHub:
https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/issues/343*issuecomment-1007399109__;Iw!!G2kpM7uM-TzIFchu!kCPBGs5G8fFI1lAeXRdUl839RH7nl6w8km2hYL9TQwP02-ABIkn5JWvsLq67IE1EKFScYy98k3Y$
 
You are receiving this because you are subscribed to this thread.

Message ID: 
This list forwards relevant notifications from Github.  It is distinct from 
cf-metad...@cgd.ucar.edu, although if you do nothing, a subscription to the 
UCAR list will result in a subscription to this list.
To unsubscribe from this list only, send a message to 
cf-metadata-unsubscribe-requ...@listserv.llnl.gov.


Re: [CF-metadata] [cf-convention/cf-conventions] Single-source the version number (Issue #343)

2022-01-07 Thread Daniel Lee
>From @zklaus in 
>https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/pull/344*issuecomment-1007108115__;Iw!!G2kpM7uM-TzIFchu!nzfFRuwavWqsiYAnVaPztGBBgkQDo_YadSDdBXX2OYtbfvHDKgQmoST4eJMEM8vFe2_WhuQ-6Z4$
> :
> I have added a fancified version of the version handling. Let me know what 
> you think or if you want me to explain a bit more.
> 
> PS: I am totally happy to roll back the last commit and to just add ` draft` 
> or `-draft` to the version. Just thought I'd show one other way that we could 
> go about this to improve automation.

I think this is pretty elegant - IMO in order to make this perfect the way to 
go would be to change [the build 
workflow](https://urldefense.us/v3/__https://github.com/zklaus/cf-conventions/blob/single-source-version/.github/workflows/adoc_build.yml__;!!G2kpM7uM-TzIFchu!nzfFRuwavWqsiYAnVaPztGBBgkQDo_YadSDdBXX2OYtbfvHDKgQmoST4eJMEM8vFe2_WU-Yetuk$
 ) to run with `-a final` as described 
[here](https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/pull/344/files*diff-5ff41050491a2b74889153ce01bd77a1b09e5acbd156063709f330a2ef0bcc8eR7__;Iw!!G2kpM7uM-TzIFchu!nzfFRuwavWqsiYAnVaPztGBBgkQDo_YadSDdBXX2OYtbfvHDKgQmoST4eJMEM8vFe2_WeJFdl0U$
 ) on full tags - that sounds straightforward but I'm not sure if that's easy 
to do though, as I don't have a clear pathway to do that in mind. Any thoughts 
on that, and would anybody be interested in some extra credit for improving the 
build process? ;)

-- 
Reply to this email directly or view it on GitHub:
https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/issues/343*issuecomment-1007265396__;Iw!!G2kpM7uM-TzIFchu!nzfFRuwavWqsiYAnVaPztGBBgkQDo_YadSDdBXX2OYtbfvHDKgQmoST4eJMEM8vFe2_WO91k0_s$
 
You are receiving this because you are subscribed to this thread.

Message ID: 
This list forwards relevant notifications from Github.  It is distinct from 
cf-metad...@cgd.ucar.edu, although if you do nothing, a subscription to the 
UCAR list will result in a subscription to this list.
To unsubscribe from this list only, send a message to 
cf-metadata-unsubscribe-requ...@listserv.llnl.gov.


Re: [CF-metadata] [cf-convention/cf-conventions] Single source version (PR #344)

2022-01-07 Thread Daniel Lee
@erget approved this pull request.





-- 
Reply to this email directly or view it on GitHub:
https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/pull/344*pullrequestreview-846429155__;Iw!!G2kpM7uM-TzIFchu!gjlHWVKXdza87fBXgWxjOwY0_ebHrPPWjPn20bkyeSmb0dKKXZIdm-RQEwwAl_Sg-9FRnmt4b0w$
 
You are receiving this because you are subscribed to this thread.

Message ID: 
This list forwards relevant notifications from Github.  It is distinct from 
cf-metad...@cgd.ucar.edu, although if you do nothing, a subscription to the 
UCAR list will result in a subscription to this list.
To unsubscribe from this list only, send a message to 
cf-metadata-unsubscribe-requ...@listserv.llnl.gov.


Re: [CF-metadata] [cf-convention/cf-conventions] Cutting version 1.10 (Issue #345)

2022-01-07 Thread Daniel Lee
@davidhassell agree with all your points. I also agree about the issue labels 
of changes being agreed or not, that would be easy to do and add value.

When we consider these process changes agreed, we should document them, e.g. in 
Rules.md or in the PR templates, in the form of a checklist. They're simple to 
do but would need easy presentation so that they don't get forgotten.

-- 
Reply to this email directly or view it on GitHub:
https://urldefense.us/v3/__https://github.com/cf-convention/cf-conventions/issues/345*issuecomment-1007261578__;Iw!!G2kpM7uM-TzIFchu!gtcpnk-hOgpXm09GDPhi-17oGQz664bIwNWGLLj_gZx1uTQLMeR9fdJ8aRnr1rzd71RuwuKWkVw$
 
You are receiving this because you are subscribed to this thread.

Message ID: 
This list forwards relevant notifications from Github.  It is distinct from 
cf-metad...@cgd.ucar.edu, although if you do nothing, a subscription to the 
UCAR list will result in a subscription to this list.
To unsubscribe from this list only, send a message to 
cf-metadata-unsubscribe-requ...@listserv.llnl.gov.