search

thewca / wca-regulations

Regulations and Guidelines for the World Cube Association.
https://www.worldcubeassociation.org/regulations/
112 stars 65 forks source link

Add Action to Move Current Regulations to History #1191

Open FinnIckler opened 7 months ago

FinnIckler commented 7 months ago

This should be triggered before a new regulations cycle. It can be then linked to in the history file

Nevseros commented 7 months ago

This does not include adding a line saying that this version is not the current one, right?

FinnIckler commented 7 months ago

You are right, I'll add that tomorrow

FinnIckler commented 7 months ago

https://github.com/thewca/worldcubeassociation.org/blob/regulations-data/regulations/build/regulations/history/official/2023-08-01/index.html.erb it looks like it also wasn't added the last time regulations were cycled!

Nevseros commented 7 months ago

@FinnIckler

it looks like it also wasn't added the last time regulations were cycled!

Because we add regulations on the history page as soon as we announce them (2024-01-01 should be there too now, for example, but I've been lazy) to be able to reference a current regulation with permalink (during investigations, for example).

Is it possible that upon adding a current version to the history the previous version file is edited with the disclaimer, but not the one that's being added? Like I did in these two PRs in total: 8183 and 8283.

FinnIckler commented 7 months ago

The github action can't figure out what the current/previous version is unless you explicitly tell it through an input variable. What we could do is also add the current version to its history folder every time the official branch is updated and then have this action that just inserts the disclaimer for a given version.

FinnIckler commented 3 months ago

So I can pick this one up again. What does WRC think about my suggestion about replacing the current regulations in history every time it's updated?

Nanush7 commented 3 months ago

How would the process look like from our side? We just need to update the version file in the history folder?

FinnIckler commented 3 months ago

No, the process from your side would just be like now, you push to this repo to the official branch and that would replace both the latest version and the latest version in history. If you then need to add the disclaimer you can run this Action.

I am looking into it and I think I can't implement it here, instead the wrc compiler needs to put the current files into the history folde

I can just do it here

FinnIckler commented 3 months ago

I added a step to the deploy-to-s3 action that copies the current version into the history. When you cycle regulations you just need to: