w3c / vc-jose-cose

Verifiable Credentials Working Group — VC JSON Web Tokens specification
https://w3c.github.io/vc-jose-cose/
Other
31 stars 13 forks source link

Change short name to vc-jose-cose #115

Closed mprorock closed 1 year ago

mprorock commented 1 year ago

putting this adjustment in its own pr


Preview | Diff

iherman commented 1 year ago

FYI: I have asked the webmaster to tell me shat it entails to change the short name of a Rec-track publication.

iherman commented 1 year ago

Here are the steps that we will have to follow to officially change the short name of the spec as far as the W3C publication system goes:

  1. Switch echidna off
  2. The editor prepares a publishing ready version of the spec using the respec facilities and stores it somewhere where I can access it
  3. I (or the editor) has to modify the version generated by respec by adding a special data-previous-shortname attribute at a specific place, see [1] for the details
  4. The document gets published in the old-skool way by pushing it to the W3C server (something I have to do) and ask the webmaster to make an official publication
  5. Once the official publication is done, our echidna script should be modified (see [2]) and then re-instated

Once this process is started, no new PR should be merged until step (5) has been reached, to avoid versioning problems.

This has to be done only once to add the information to the publication change.

[1] https://www.w3.org/pubrules/doc/rules/?profile=WD#docIDHistory [2] https://github.com/w3c/vc-jwt/blob/197b357151d92f3ec4ca9ef65e69990f2df259db/.github/workflows/auto-publish.yml#L19

cc: @deniak

iherman commented 1 year ago

Adding to the practical aspect in https://github.com/w3c/vc-jwt/pull/115#issuecomment-1620408736, I believe that any such change would require a formal resolution of the WG; just as the decision on the choice of the short name, I guess any change thereof should be on record.

cc @Sakurann @brentzundel

OR13 commented 1 year ago

I will open a PR that does 1-3 here: https://github.com/w3c/vc-jwt/pull/115#issuecomment-1620408736

We will old all the PRs after that PR is merged,

We will complete

4 and 5

We will unblock the open PRs.

iherman commented 1 year ago

The issue was discussed in a meeting on 2023-07-12

List of resolutions:

View the transcript ### 3. VC-JWT shortname change to vc-jose-cose. **Brent Zundel:** there has been discussion of the vc-jwt spec... people seems to like vc-jose-cose. … seems to adjust the name to better refect the work that has been done. _See github pull request [vc-jwt#115](https://github.com/w3c/vc-jwt/pull/115)._ **Brent Zundel:** seems pretty straightforward. … any changes requested? **Manu Sporny:** Regarding our charter... … our charter doesn't explicitly list COSE as being in scope. … However, we note, under the Securing Verifiable Credentials (SVC) 1.0 section of the charter, that "The following are a non-exhaustive selection of expected input documents". … and the group has decided that defining JOSE and COSE would be useful. … Therefore, the charter allows for this change to be made. **Brent Zundel:** yes, our charter says we are allowed to have various input documents. … seems cose is in scope, as a possible securing mechanism. … for the record, our charter lists JWT in scope, it also says something about PGP. > **Proposed resolution: change the shortname and repository of VC-JWT to vc-jose-cose.** *(Brent Zundel)* > *Brent Zundel:* +1. > *Orie Steele:* +1. > *Andres Uribe:* +1. > *Chris Abernethy:* +1. > *Ivan Herman:* +1. > *Manu Sporny:* +0.75 (due to concerns around scope creep). > *Dave Longley:* +1. > *Ted Thibodeau Jr.:* +1. > *Will Abramson:* +1. > *Gabe Cohen:* +0 it's hard to say. > *pauld gs1:* +1. > ***Resolution #1: change the shortname and repository of VC-JWT to vc-jose-cose.*** **Ivan Herman:** yeah so... on the practicalities. I had discussed this with the web master. … there is an issue comment: [https://github.com/w3c/vc-jwt/pull/115#issuecomment-1620408736](https://github.com/w3c/vc-jwt/pull/115#issuecomment-1620408736). … it describes what has to be done... in terms of changing the repo name / TR... etc... its a bit complicated. … who will do the work? … I am not sure who is really driving this document. … I don't know who my partner will be. **Orie Steele:** I'm happy to make the necessary changes, Ivan. Let me know what changes need to be made. **Ivan Herman:** thanks orie, please go through the list on the issue comment, sometime next week.
OR13 commented 1 year ago

@iherman 1-3 are complete over here:

https://github.com/w3c/vc-jwt/pull/125/commits/c6b17eef668bf195ac37d670d52355ed7a606121

Your instructions seem to be lacking a comment on applying the new short name.

Should I change vc-jwt to vc-jose-cose in https://github.com/w3c/vc-jwt/pull/125 ?

OR13 commented 1 year ago

Closing this in favor of https://github.com/w3c/vc-jwt/pull/126