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.

Sign up for GitHub

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

Jump to bottom

Introduce a workflow updating the wishlist leaderboards #5085

Merged
merged 2 commits into from
Jul 24, 2024
Merged

Introduce a workflow updating the wishlist leaderboards #5085

merged 2 commits into from
Jul 24, 2024

Conversation

rzadp
Copy link
Contributor

@rzadp rzadp commented Jul 19, 2024

The workflow periodically updates the leaderboards of the wishlist issues: #3900 and #3901

The code is adopted from here, with slight modifications.

Previously, the score could be increased by the same person adding different reactions. Also, some wishes have a score of 0 - even thought there is a wish for them, because the author was not counted.

Now, the score is a unique count of upvoters of the desired issue, upvoters of the wish comment, and the author of the wish comment.

I changed the format to include the Last updated: at the bottom - it will be automatically updated.

@rzadp rzadp added the R0-silent Changes should not be mentioned in any release notes label Jul 19, 2024
@rzadp rzadp requested review from a team as code owners July 19, 2024 18:39
@rzadp rzadp requested a review from kianenigma July 19, 2024 18:39
@rzadp rzadp mentioned this pull request Jul 19, 2024
Closed
kianenigma
kianenigma reviewed Jul 21, 2024
View reviewed changes
.github/workflows/misc-update-wishlist-leaderboard.yml

on:
schedule:
# Run every 3 hours
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think every day is fine, but probably this is cheap af :D

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The job takes ~1 minute 15 secs to run.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

default ubuntu-latest are free for public repos

kianenigma
kianenigma approved these changes Jul 21, 2024
View reviewed changes
Copy link
Contributor

@kianenigma kianenigma left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks neat. Thanks!

q: how do you test this before merge? just curious.

@rzadp
Copy link
Contributor Author

rzadp commented Jul 22, 2024

q: how do you test this before merge? just curious.

There is just a single place where the result is saved (wishlist_issue.edit(body=new_content)), so if you comment it out (and replace with print(new_content)) you can run it locally and preview the current output it will produce.

Here's how I run it locally:

export WISHLIST_REPOSITORY='paritytech/polkadot-sdk'
export WISHLIST_ISSUE_NUMBER='3900'
export GH_TOKEN='<github PAT>'

python3 -m venv venv
source venv/bin/activate
[venv] python3 -m pip install PyGithub

[venv] python3 ./.github/scripts/update-wishlist-leaderboard.py

@kianenigma
Copy link
Contributor

Okay, I meant more in the sense that how can you test GHA env locally. I recall I used some dockerized tool for this in the past and it was quite slow.

@paritytech-review-bot paritytech-review-bot bot requested a review from a team July 22, 2024 10:24
@rzadp
Copy link
Contributor Author

rzadp commented Jul 22, 2024

Okay, I meant more in the sense that how can you test GHA env locally. I recall I used some dockerized tool for this in the past and it was quite slow.

Ah, in that case I run it in a real, playground github repo with small edits (to run on every push, to not edit real data) before eventually copying to target repo for a PR.

By using a 3rd party tool to run an action locally, I still wouldn't be exactly sure that I have everything configured properly (for example permissions to edit an issue) - but maybe I'm wrong?

@rzadp rzadp added this pull request to the merge queue Jul 24, 2024
Merged via the queue into master with commit 60d21e9 Jul 24, 2024
169 of 172 checks passed
@rzadp rzadp deleted the rzadp/update-wishlist-leaderboard branch July 24, 2024 18:47
TarekkMA pushed a commit to moonbeam-foundation/polkadot-sdk that referenced this pull request Aug 2, 2024
@rzadp @TarekkMA
Introduce a workflow updating the wishlist leaderboards (paritytech#5085
61749e6 
)

- Closes paritytech/eng-automation#11

The workflow periodically updates the leaderboards of the wishlist
issues: paritytech#3900 and
paritytech#3901

The code is adopted from
[here](https://github.com/kianenigma/wishlist-tracker), with slight
modifications.

Previously, the score could be increased by the same person adding
different reactions. Also, some wishes have a score of 0 - even thought
there is a wish for them, because the author was not counted.

Now, the score is a unique count of upvoters of the desired issue,
upvoters of the wish comment, and the author of the wish comment.

I changed the format to include the `Last updated:` at the bottom - it
will be automatically updated.
@kianenigma
Copy link
Contributor

A bit doubtful if this is working: #3901 (comment)

For example this RFC has 16 ups, but is not listed.

@rzadp rzadp mentioned this pull request Aug 6, 2024
Merged
@rzadp
Copy link
Contributor Author

rzadp commented Aug 6, 2024

A bit doubtful if this is working: #3901 (comment)

For example this RFC has 16 ups, but is not listed.

Ah, that's a PR, not an issue - I missed this!

It's a quick fix: #5256

ordian added a commit that referenced this pull request Aug 6, 2024
@ordian
Merge branch 'master' into ao-fix-parainclusion-weight-overestimation
b235de4 
* master: (27 commits)
  Bridges improved tests and nits (#5128)
  Fix misleading comment about RewardHandler in epm config (#3095)
  Introduce a workflow updating the wishlist leaderboards (#5085)
  membership: Restructure pallet into separate files (#4536)
  Fix after ring-proof api change (#5126)
  Bump paritytech/review-bot from 2.4.0 to 2.5.0 (#5057)
  Bump docker/login-action from 3.0.0 to 3.3.0 (#5109)
  Bump docker/build-push-action from 5.1.0 to 6.5.0 (#5108)
  Bump peter-evans/create-pull-request from 5.0.0 to 6.1.0 (#5093)
  Tx Payment: drop ED requirements for tx payments with exchangeable asset  (#4488)
  Remove `pallet-getter` usage from pallet-transaction-payment (#4970)
  pallet macro: do not generate try-runtime related code when frame-support doesn't have try-runtime. (#5099)
  fix(chain-spec): ChainSpecBuilder with object as default genesis (#4345)
  Migrate BEEFY BLS crypto to  bls12-381 curve (#4931)
  Bump clap from 4.5.9 to 4.5.10 in the known_good_semver group (#5120)
  Use jobserver in wasm-builder to limit concurrency of spawned cargo processes (#4946)
  include events for voting (#4613)
  [subsystem-bench] Add mocks for own assignments triggering (#5042)
  Remove not-audited warning (#5114)
  hotfix: blockchain/backend: Skip genesis leaf to unblock syncing (#5103)
  ...
github-merge-queue bot pushed a commit that referenced this pull request Aug 7, 2024
@rzadp
Update the wishlist leaderboard script to handle PRs (#5256)
34e64c7 
Addresses
#5085 (comment)

Luckily, in the rest of the script, github API allows (or forces?) us to
read the state of PRs the same way as we read the state of issues, so it
works without any more changes.
@mittal-parth
Copy link
Contributor

Can we make these jobs run only for the main repo and not for forks? I keep getting emails for failed jobs every few hours.

There is an option to manually disable all jobs for a fork but I would say its better to add a if: github.repository == 'paritytech/polkadot-sdk'?

Reference: https://github.com/orgs/community/discussions/26704

@rzadp rzadp mentioned this pull request Aug 9, 2024
Merged
@rzadp
Copy link
Contributor Author

rzadp commented Aug 9, 2024

@mittal-parth Totally, thanks for reporting this. Created #5297.

github-merge-queue bot pushed a commit that referenced this pull request Aug 14, 2024
@rzadp
Stop running the wishlist workflow on forks (#5297)
d944ac2 
Addresses
#5085 (comment)
dharjeezy pushed a commit to dharjeezy/polkadot-sdk that referenced this pull request Aug 28, 2024
@rzadp @dharjeezy
Update the wishlist leaderboard script to handle PRs (paritytech#5256)
d4355af 
Addresses
paritytech#5085 (comment)

Luckily, in the rest of the script, github API allows (or forces?) us to
read the state of PRs the same way as we read the state of issues, so it
works without any more changes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@alvicsam alvicsam alvicsam approved these changes

@EgorPopelyaev EgorPopelyaev EgorPopelyaev approved these changes

@kianenigma kianenigma kianenigma approved these changes

@mordamax mordamax mordamax approved these changes

Assignees
No one assigned
Labels
R0-silent Changes should not be mentioned in any release notes
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Automate updating the Wishlist issues
6 participants
@rzadp @kianenigma @mittal-parth @mordamax @EgorPopelyaev @alvicsam