publiccode.yml icon indicating copy to clipboard operation
publiccode.yml copied to clipboard

Make "releaseDate" key an optional key

Open tomootes opened this issue 2 years ago • 5 comments

As stated in the following thread. It would be logical to make the releaseDate key optional.

Main reasons that can be coined for this are:

  • Some repositories don't use release tags (SemVer). These repo's don't have a logical release date. In practice a lot of repositories will use Continuous Delivery and for these this will be the case.
  • It could be argued that it is undesirable if the publiccode.yml becomes a file that has to be updated very often. In the case of developer.overheid.nl we can also fetch the date of the last release via the Gitlab/Github API.

tomootes avatar Dec 14 '23 14:12 tomootes

@tomootes, I agree with both points. Adding to the second: the need to update releaseDate every time results in either not updating it, or it becomes busywork that just annoys the maintainers and makes them roll their eyes at publiccode.yml.

Having it optional makes it available to people who wanna opt-in for that.

bfabio avatar Dec 30 '23 18:12 bfabio

@yaml-9000 minor-change

bfabio avatar Dec 30 '23 18:12 bfabio

Thanks for your contribution :pray:

This is now marked as a minor-change proposal to the standard, this means that old versions of publiccode.yml will still be valid with this change.

Example of minor changes are additions of new keys or making keys optional.

The Chair will eventually pick up this proposal and start the voting procedure using @yaml-9000 vote-start

cc @ruphy @publiccodeyml/steering-committee

:page_facing_up: Voting procedure | :page_facing_up: Working Group Charter | :robot: bot commands

yaml-9000 avatar Dec 30 '23 18:12 yaml-9000

@tomootes, I agree with both points. Adding to the second: the need to update releaseDate every time results in either not updating it, or it becomes busywork that just annoys the maintainers and makes them roll their eyes at publiccode.yml.

Having it optional makes it available to people who wanna opt-in for that.

I can't agree more on this one. In addition to this: if a project is using semver the last releasedate can easily be fetched from either Github or Gitlab. If we keep it mandatory this is going to be an extra chore for devs.

tomootes avatar Feb 27 '24 10:02 tomootes

I updated the translations as well and rebased so the preview is successful.

bfabio avatar Mar 05 '24 11:03 bfabio

@yaml-9000 vote-start

ruphy avatar May 29 '24 12:05 ruphy

Voting is now open on this proposal!

If you are a member of the Steering Committee you can now vote!

The polls will stay open for 14 days, until Wed, 12 Jun 2024 12:33:59 GMT. At the end of that period the Chair (@publiccodeyml/chair) will mark the voting period as over using @yaml-9000 vote-end

Leave a :+1: (thumbs up) on this comment to accept the proposal or a :-1: (thumbs down) to reject it.

cc @publiccodeyml/steering-committee

:page_facing_up: Voting procedure | :page_facing_up: Working Group Charter | :robot: bot commands

yaml-9000 avatar May 29 '24 12:05 yaml-9000

@yaml-9000 vote-end

bfabio avatar Jun 13 '24 18:06 bfabio

Vote results

The results of the vote are:

Vote Members Votes count Percentage
:+1: Approve @bzg @ruphy 2 100.0%
:-1: Reject 0 -

Proposal approved :+1:

This proposal is now ready to be merged and get released with a new version of the standard.

cc @publiccodeyml/chair @publiccodeyml/maintainers

Details

First round: unanimity required

The following users voted (includes non-members of the steering committee):

  • bfabio voted :+1:

  • bzg voted :+1:

  • ruphy voted :+1:

:page_facing_up: Voting procedure | :page_facing_up: Working Group Charter | :robot: bot commands

yaml-9000 avatar Jun 13 '24 18:06 yaml-9000

Awesome to see the change has been accepted and is now part of the standard :pray:

tomootes avatar Jun 26 '24 13:06 tomootes