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

Implementation of project board automations #3375

Merged
merged 51 commits into from
Nov 23, 2023
Merged

Conversation

dhruvkb
Copy link
Member

@dhruvkb dhruvkb commented Nov 20, 2023

Fixes

Fixes #3374 by @dhruvkb

Description

This PR implements the changes and additions to the project automations as per the plan outlined in #3042.

Given how GitHub Actions development goes, I'm anticipating quite a few revisions on this work once the actions start running and failing and exposing edge cases so if you could review it a bit deeply, we might catch and patch those cases faster.

Testing Instructions

The changes are so tightly coupled with GitHub that it's very hard to test them at all. Also they need an access token making it not possible to test them in CI. However here are some bits that you can test locally.

Project

  1. Create and export your personal access token export ACCESS_TOKEN=<your token>.
  2. Open node REPL from the automations/js directory.
  3. Try this:
    > const octokit = require('@octokit/rest')
    > const projects = await import('./src/utils/projects.mjs')
    >
    > const { ACCESS_TOKEN } = process.env
    > const oct = new octokit.Octokit({ auth: ACCESS_TOKEN })
    > const backlogBoard = await projects.getBoard(oct, 'Backlog')
    > backlogBoard.projectId
      'PVT_kwDOAAQ2Js4AMZdL'
    > backlogBoard.columns
      {
        Blocked: '⛔ Blocked',
        Backlog: '📋 Backlog',
        ToDo: '📅 To Do',
        InProgress: '🏗 In Progress',
        Done: '✅ Done',
        Discarded: '🗑 Discarded'
      }

PullRequest

  1. Create and export your personal access token export ACCESS_TOKEN=<your token>.
  2. Open node REPL from the automations/js directory.
  3. Try this:
    > const octokit = require('@octokit/rest')
    > const pr = await import('./src/utils/pr.mjs')
    >
    > const { ACCESS_TOKEN } = process.env
    > const oct = new octokit.Octokit({ auth: ACCESS_TOKEN })
    > let pull = new pr.PullRequest(oct, "PR_kwDOFU_ugM5f4yt7")
    > await pull.init()
    > pull.reviewDecision
      'CHANGES_REQUESTED'
    > pull.linkedIssues
      [ 'I_kwDOFU_ugM5ssiSa' ]
    > pull.reviewCounts
      {
        APPROVED: 0,
        COMMENTED: 1,
        CHANGES_REQUESTED: 1,
        DISMISSED: 0,
        PENDING: 0
      }

Checklist

  • My pull request has a descriptive title (not a vague title likeUpdate index.md).
  • My pull request targets the default branch of the repository (main) or a parent feature branch.
  • My commit messages follow best practices.
  • My code follows the established code style of the repository.
  • I added or updated tests for the changes I made (if applicable).
  • I added or updated documentation (if applicable).
  • I tried running the project locally and verified that there are no visible errors.
  • I ran the DAG documentation generator (if applicable).

Developer Certificate of Origin

Developer Certificate of Origin
Developer Certificate of Origin
Version 1.1

Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
1 Letterman Drive
Suite D4700
San Francisco, CA, 94129

Everyone is permitted to copy and distribute verbatim copies of this
license document, but changing it is not allowed.


Developer's Certificate of Origin 1.1

By making a contribution to this project, I certify that:

(a) The contribution was created in whole or in part by me and I
    have the right to submit it under the open source license
    indicated in the file; or

(b) The contribution is based upon previous work that, to the best
    of my knowledge, is covered under an appropriate open source
    license and I have the right under that license to submit that
    work with modifications, whether created in whole or in part
    by me, under the same open source license (unless I am
    permitted to submit under a different license), as indicated
    in the file; or

(c) The contribution was provided directly to me by some other
    person who certified (a), (b) or (c) and I have not modified
    it.

(d) I understand and agree that this project and the contribution
    are public and that a record of the contribution (including all
    personal information I submit with it, including my sign-off) is
    maintained indefinitely and may be redistributed consistent with
    this project or the open source license(s) involved.

@dhruvkb dhruvkb changed the title Project automations impl Implementation of project board automations Nov 20, 2023
@openverse-bot openverse-bot added 🟨 priority: medium Not blocking but should be addressed soon ✨ goal: improvement Improvement to an existing user-facing feature 🤖 aspect: dx Concerns developers' experience with the codebase 🧱 stack: mgmt Related to repo management and automations labels Nov 20, 2023
@github-actions github-actions bot added the 🧱 stack: frontend Related to the Nuxt frontend label Nov 20, 2023
Copy link

github-actions bot commented Nov 20, 2023

Size Change: 0 B

Total Size: 974 kB

ℹ️ View Unchanged
Filename Size
./frontend/.nuxt/dist/client/242.js 343 B
./frontend/.nuxt/dist/client/242.modern.js 346 B
./frontend/.nuxt/dist/client/243.js 1.85 kB
./frontend/.nuxt/dist/client/app.js 132 kB
./frontend/.nuxt/dist/client/app.modern.js 123 kB
./frontend/.nuxt/dist/client/commons/app.js 105 kB
./frontend/.nuxt/dist/client/commons/app.modern.js 87.4 kB
./frontend/.nuxt/dist/client/commons/components/v-error-section/components/v-external-search-form/components/v-external-source-li/4e2d09e1.js 5.18 kB
./frontend/.nuxt/dist/client/commons/components/v-error-section/components/v-external-search-form/components/v-external-source-li/4e2d09e1.modern.js 5.62 kB
./frontend/.nuxt/dist/client/components/loading-icon.js 732 B
./frontend/.nuxt/dist/client/components/loading-icon.modern.js 736 B
./frontend/.nuxt/dist/client/components/table-sort-icon.js 514 B
./frontend/.nuxt/dist/client/components/table-sort-icon.modern.js 518 B
./frontend/.nuxt/dist/client/components/v-all-results-grid.js 6.85 kB
./frontend/.nuxt/dist/client/components/v-all-results-grid.modern.js 6.68 kB
./frontend/.nuxt/dist/client/components/v-audio-collection.js 4.5 kB
./frontend/.nuxt/dist/client/components/v-audio-collection.modern.js 4.37 kB
./frontend/.nuxt/dist/client/components/v-audio-list.js 1.43 kB
./frontend/.nuxt/dist/client/components/v-audio-list.modern.js 1.4 kB
./frontend/.nuxt/dist/client/components/v-audio-result.js 1.12 kB
./frontend/.nuxt/dist/client/components/v-audio-result.modern.js 1.1 kB
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.js 956 B
./frontend/.nuxt/dist/client/components/v-audio-track-skeleton.modern.js 960 B
./frontend/.nuxt/dist/client/components/v-audio-track.js 5.99 kB
./frontend/.nuxt/dist/client/components/v-audio-track.modern.js 5.96 kB
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.js 634 B
./frontend/.nuxt/dist/client/components/v-back-to-search-results-link.modern.js 640 B
./frontend/.nuxt/dist/client/components/v-bone.js 632 B
./frontend/.nuxt/dist/client/components/v-bone.modern.js 636 B
./frontend/.nuxt/dist/client/components/v-box-layout.js 1.15 kB
./frontend/.nuxt/dist/client/components/v-box-layout.modern.js 1.16 kB
./frontend/.nuxt/dist/client/components/v-collection-header.js 1.49 kB
./frontend/.nuxt/dist/client/components/v-collection-header.modern.js 1.51 kB
./frontend/.nuxt/dist/client/components/v-content-link.js 1.06 kB
./frontend/.nuxt/dist/client/components/v-content-link.modern.js 1.06 kB
./frontend/.nuxt/dist/client/components/v-content-page.js 530 B
./frontend/.nuxt/dist/client/components/v-content-page.modern.js 536 B
./frontend/.nuxt/dist/client/components/v-content-report-button.js 493 B
./frontend/.nuxt/dist/client/components/v-content-report-button.modern.js 496 B
./frontend/.nuxt/dist/client/components/v-content-report-form.js 3.35 kB
./frontend/.nuxt/dist/client/components/v-content-report-form.modern.js 3.23 kB
./frontend/.nuxt/dist/client/components/v-content-report-popover.js 3.82 kB
./frontend/.nuxt/dist/client/components/v-content-report-popover.modern.js 3.7 kB
./frontend/.nuxt/dist/client/components/v-copy-button.js 3.8 kB
./frontend/.nuxt/dist/client/components/v-copy-button.modern.js 3.8 kB
./frontend/.nuxt/dist/client/components/v-copy-license.js 2.34 kB
./frontend/.nuxt/dist/client/components/v-copy-license.modern.js 2.31 kB
./frontend/.nuxt/dist/client/components/v-dmca-notice.js 795 B
./frontend/.nuxt/dist/client/components/v-dmca-notice.modern.js 801 B
./frontend/.nuxt/dist/client/components/v-error-image.js 2.51 kB
./frontend/.nuxt/dist/client/components/v-error-image.modern.js 2.47 kB
./frontend/.nuxt/dist/client/components/v-error-section.js 5.22 kB
./frontend/.nuxt/dist/client/components/v-error-section.modern.js 4.58 kB
./frontend/.nuxt/dist/client/components/v-external-search-form.js 4.1 kB
./frontend/.nuxt/dist/client/components/v-external-search-form.modern.js 3.44 kB
./frontend/.nuxt/dist/client/components/v-external-source-list.js 2.63 kB
./frontend/.nuxt/dist/client/components/v-external-source-list.modern.js 1.99 kB
./frontend/.nuxt/dist/client/components/v-full-layout.js 1.66 kB
./frontend/.nuxt/dist/client/components/v-full-layout.modern.js 1.66 kB
./frontend/.nuxt/dist/client/components/v-get-media-button.js 622 B
./frontend/.nuxt/dist/client/components/v-get-media-button.modern.js 628 B
./frontend/.nuxt/dist/client/components/v-grid-skeleton.js 1.55 kB
./frontend/.nuxt/dist/client/components/v-grid-skeleton.modern.js 1.55 kB
./frontend/.nuxt/dist/client/components/v-hide-button.js 594 B
./frontend/.nuxt/dist/client/components/v-hide-button.modern.js 592 B
./frontend/.nuxt/dist/client/components/v-home-gallery.js 4.28 kB
./frontend/.nuxt/dist/client/components/v-home-gallery.modern.js 4.26 kB
./frontend/.nuxt/dist/client/components/v-homepage-content.js 1.82 kB
./frontend/.nuxt/dist/client/components/v-homepage-content.modern.js 1.79 kB
./frontend/.nuxt/dist/client/components/v-image-cell.js 2.24 kB
./frontend/.nuxt/dist/client/components/v-image-cell.modern.js 2.23 kB
./frontend/.nuxt/dist/client/components/v-image-grid.js 4.52 kB
./frontend/.nuxt/dist/client/components/v-image-grid.modern.js 4.4 kB
./frontend/.nuxt/dist/client/components/v-license-tab-panel.js 641 B
./frontend/.nuxt/dist/client/components/v-license-tab-panel.modern.js 649 B
./frontend/.nuxt/dist/client/components/v-load-more.js 1.18 kB
./frontend/.nuxt/dist/client/components/v-load-more.modern.js 1.07 kB
./frontend/.nuxt/dist/client/components/v-media-details.js 5.84 kB
./frontend/.nuxt/dist/client/components/v-media-details.modern.js 5.69 kB
./frontend/.nuxt/dist/client/components/v-media-license.js 930 B
./frontend/.nuxt/dist/client/components/v-media-license.modern.js 938 B
./frontend/.nuxt/dist/client/components/v-media-reuse.js 3 kB
./frontend/.nuxt/dist/client/components/v-media-reuse.modern.js 2.97 kB
./frontend/.nuxt/dist/client/components/v-media-tag.js 416 B
./frontend/.nuxt/dist/client/components/v-media-tag.modern.js 419 B
./frontend/.nuxt/dist/client/components/v-media-tags.js 830 B
./frontend/.nuxt/dist/client/components/v-media-tags.modern.js 824 B
./frontend/.nuxt/dist/client/components/v-metadata-value.js 604 B
./frontend/.nuxt/dist/client/components/v-metadata-value.modern.js 609 B
./frontend/.nuxt/dist/client/components/v-metadata.js 1.32 kB
./frontend/.nuxt/dist/client/components/v-metadata.modern.js 1.32 kB
./frontend/.nuxt/dist/client/components/v-modal.js 981 B
./frontend/.nuxt/dist/client/components/v-modal.modern.js 973 B
./frontend/.nuxt/dist/client/components/v-no-results.js 2.67 kB
./frontend/.nuxt/dist/client/components/v-no-results.modern.js 2.03 kB
./frontend/.nuxt/dist/client/components/v-old-icon-button.js 853 B
./frontend/.nuxt/dist/client/components/v-old-icon-button.modern.js 846 B
./frontend/.nuxt/dist/client/components/v-radio.js 1.02 kB
./frontend/.nuxt/dist/client/components/v-radio.modern.js 1.02 kB
./frontend/.nuxt/dist/client/components/v-related-audio.js 823 B
./frontend/.nuxt/dist/client/components/v-related-audio.modern.js 743 B
./frontend/.nuxt/dist/client/components/v-related-audio/pages/search/audio.js 4.49 kB
./frontend/.nuxt/dist/client/components/v-related-audio/pages/search/audio.modern.js 4.36 kB
./frontend/.nuxt/dist/client/components/v-related-images.js 803 B
./frontend/.nuxt/dist/client/components/v-related-images.modern.js 719 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.js 996 B
./frontend/.nuxt/dist/client/components/v-report-desc-form.modern.js 999 B
./frontend/.nuxt/dist/client/components/v-row-layout.js 2.04 kB
./frontend/.nuxt/dist/client/components/v-row-layout.modern.js 2.05 kB
./frontend/.nuxt/dist/client/components/v-safety-wall.js 1.45 kB
./frontend/.nuxt/dist/client/components/v-safety-wall.modern.js 1.46 kB
./frontend/.nuxt/dist/client/components/v-scroll-button.js 891 B
./frontend/.nuxt/dist/client/components/v-scroll-button.modern.js 892 B
./frontend/.nuxt/dist/client/components/v-search-results-title.js 616 B
./frontend/.nuxt/dist/client/components/v-search-results-title.modern.js 621 B
./frontend/.nuxt/dist/client/components/v-single-result-controls.js 1.18 kB
./frontend/.nuxt/dist/client/components/v-single-result-controls.modern.js 1.18 kB
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.js 1.02 kB
./frontend/.nuxt/dist/client/components/v-sketch-fab-viewer.modern.js 916 B
./frontend/.nuxt/dist/client/components/v-snackbar.js 1.06 kB
./frontend/.nuxt/dist/client/components/v-snackbar.modern.js 1.07 kB
./frontend/.nuxt/dist/client/components/v-sources-table.js 15.1 kB
./frontend/.nuxt/dist/client/components/v-sources-table.modern.js 15.1 kB
./frontend/.nuxt/dist/client/components/v-tag.js 411 B
./frontend/.nuxt/dist/client/components/v-tag.modern.js 415 B
./frontend/.nuxt/dist/client/components/v-warning-suppressor.js 306 B
./frontend/.nuxt/dist/client/components/v-warning-suppressor.modern.js 311 B
./frontend/.nuxt/dist/client/pages/about.js 1.42 kB
./frontend/.nuxt/dist/client/pages/about.modern.js 1.42 kB
./frontend/.nuxt/dist/client/pages/audio/_id/index.js 17.5 kB
./frontend/.nuxt/dist/client/pages/audio/_id/index.modern.js 16.4 kB
./frontend/.nuxt/dist/client/pages/feedback.js 1.36 kB
./frontend/.nuxt/dist/client/pages/feedback.modern.js 1.36 kB
./frontend/.nuxt/dist/client/pages/image/_id/index.js 16.2 kB
./frontend/.nuxt/dist/client/pages/image/_id/index.modern.js 14.8 kB
./frontend/.nuxt/dist/client/pages/image/_id/report.js 5 kB
./frontend/.nuxt/dist/client/pages/image/_id/report.modern.js 4.75 kB
./frontend/.nuxt/dist/client/pages/index.js 6.41 kB
./frontend/.nuxt/dist/client/pages/index.modern.js 6.35 kB
./frontend/.nuxt/dist/client/pages/preferences.js 1.46 kB
./frontend/.nuxt/dist/client/pages/preferences.modern.js 1.46 kB
./frontend/.nuxt/dist/client/pages/privacy.js 1.26 kB
./frontend/.nuxt/dist/client/pages/privacy.modern.js 1.26 kB
./frontend/.nuxt/dist/client/pages/search-help.js 1.64 kB
./frontend/.nuxt/dist/client/pages/search-help.modern.js 1.62 kB
./frontend/.nuxt/dist/client/pages/search.js 5.82 kB
./frontend/.nuxt/dist/client/pages/search.modern.js 8.14 kB
./frontend/.nuxt/dist/client/pages/search/audio.js 498 B
./frontend/.nuxt/dist/client/pages/search/audio.modern.js 501 B
./frontend/.nuxt/dist/client/pages/search/image.js 453 B
./frontend/.nuxt/dist/client/pages/search/image.modern.js 454 B
./frontend/.nuxt/dist/client/pages/search/index.js 316 B
./frontend/.nuxt/dist/client/pages/search/index.modern.js 320 B
./frontend/.nuxt/dist/client/pages/search/model-3d.js 243 B
./frontend/.nuxt/dist/client/pages/search/model-3d.modern.js 246 B
./frontend/.nuxt/dist/client/pages/search/video.js 240 B
./frontend/.nuxt/dist/client/pages/search/video.modern.js 244 B
./frontend/.nuxt/dist/client/pages/sensitive-content.js 1.52 kB
./frontend/.nuxt/dist/client/pages/sensitive-content.modern.js 1.53 kB
./frontend/.nuxt/dist/client/pages/sources.js 1.53 kB
./frontend/.nuxt/dist/client/pages/sources.modern.js 1.54 kB
./frontend/.nuxt/dist/client/runtime.js 2.8 kB
./frontend/.nuxt/dist/client/runtime.modern.js 2.81 kB
./frontend/.nuxt/dist/client/vendors/app.js 68.5 kB
./frontend/.nuxt/dist/client/vendors/app.modern.js 68 kB

compressed-size-action

@github-actions github-actions bot added the 🧱 stack: documentation Related to Sphinx documentation label Nov 20, 2023
Copy link

@dhruvkb dhruvkb force-pushed the project_automations_impl branch from e277220 to 4e5a052 Compare November 22, 2023 09:58
@dhruvkb dhruvkb marked this pull request as ready for review November 22, 2023 11:16
Comment on lines +69 to +72
- name: Unzip artifact
run: |
unzip event_info.zip
mv event.json /tmp/event.json
Copy link
Member Author

Choose a reason for hiding this comment

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

This is one thing that's bothering me a lot, it's two lines of Bash breaking up two action/github-scripts. Surely it could be done inside JS? Or the previous step in Bash?

Copy link
Collaborator

Choose a reason for hiding this comment

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

Could use https://www.npmjs.com/package/unzipper to do the unzipping in JavaScript? Converting the previous github script to bash looks more complicated to me (lots of gh cli response parsing 🫠).

Copy link
Member

@krysal krysal left a comment

Choose a reason for hiding this comment

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

This looks excellent, @dhruvkb! Nice finding a workaround for PRs. Given the complexity, it looks like that could have been a separate PR, but now it's done 👍

automations/js/src/utils/pr.mjs Show resolved Hide resolved
@dhruvkb dhruvkb merged commit 8d8d4ea into main Nov 23, 2023
48 checks passed
@dhruvkb dhruvkb deleted the project_automations_impl branch November 23, 2023 04:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🤖 aspect: dx Concerns developers' experience with the codebase ✨ goal: improvement Improvement to an existing user-facing feature 🟨 priority: medium Not blocking but should be addressed soon 🧱 stack: documentation Related to Sphinx documentation 🧱 stack: frontend Related to the Nuxt frontend 🧱 stack: mgmt Related to repo management and automations
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Implementation of the project automation changes
4 participants