Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enforce folder numbering #203

Open
maurelian opened this issue May 21, 2024 · 7 comments
Open

Enforce folder numbering #203

maurelian opened this issue May 21, 2024 · 7 comments
Assignees
Labels
good first issue Good for newcomers

Comments

@maurelian
Copy link
Contributor

We should add a check in CI to ensure that within a task folder, the numbering of tasks is increasing and does not overlap.

ie. #200 currently introduces a new dir tasks/sep/009-fpac-upgrade which is incorrect since there is already a tasks/sep/009-presigned-pause.

This happens easily due to race conditions between new tasks, so we should automatically check for it.

@ShubhSensei
Copy link
Contributor

May i work on this issue?

@mds1
Copy link
Contributor

mds1 commented Sep 27, 2024

Hey @ShubhSensei, are you still interested in working on this? If so, here is my thinking for what we should do:

  • Add a new script/utils/check-task-numbering.sh
  • This is a shell script that loops through every tasks/{network} folder. These folders contain a bunch of tasks of the form {number}-{optionalOtherNumber-}{taskName}
  • We call {number}-{optionalOtherNumber-} the task prefix
  • For each folder, ensure that every task prefix is unique
  • Run this new shell script in CI

I think we should only check for uniqueness, and not for any type of ordering or incrementing pattern. This is because:

  1. Uniqueness is simpler
  2. We do not always add tasks in order, i.e. sometimes for a bundle of upcoming tasks we'll add task 018 before task 017 is ready, but we don't want to block task 018 from being merged

@maurelian what do you think of this spec?

@mds1 mds1 added the good first issue Good for newcomers label Sep 27, 2024
@ShubhSensei
Copy link
Contributor

Yes @mds1 of course... I'm on it 🫡
BTW, is their any other medium where I can solve my queries otherwise it'll take forever like this.

@mds1
Copy link
Contributor

mds1 commented Sep 30, 2024

Thanks, assigned! And apologies for the slow response here, I had meant to come back to this after #152 was addressed but never did 😅

@maurelian
Copy link
Contributor Author

The spec LGTM yes.

@ShubhSensei
Copy link
Contributor

How do I run this script in CI? @mds1

@mds1
Copy link
Contributor

mds1 commented Oct 7, 2024

How do I run this script in CI?

I left a comment on the PR with this info

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants