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

build(docs-infra): introduce new process for generating data for the events page #45588

Closed
wants to merge 2 commits into from

Conversation

gkalpak
Copy link
Member

@gkalpak gkalpak commented Apr 11, 2022

This PR introduces a new process for generating data for the AIO events page, which streamlines the process and minimizes duplication and manual work. For more details, see aio/scripts/generate-events/README.md.

TODECIDE

  • How we want to present dates (esp. the Starts on prefix).
    We will use the YYYY-MM-DD format and change the column header to "Start date"
  • What to do about events with invalid dates. (Currently, the script prints them and then removes them from the list.)
    The current behavior is fine.
  • Whether we want to update past events with links (or maybe just the 2022 ones).
    We can do that, but we also don’t have links for all the events. We’ll try to be mindful for 2022 events from now on. It’s fine if we don’t have links for all the events from the start.
  • Whether we want to automatically keep X last years worth of events.
    (We could keep them all in the DB, but not put them in events.json for displaying in AIO.)
    For now, we will display all events (since 2019). In the future, we might want to revisit this and only show a limited number of years or show all available years but as collapsibles.
  • How much back we want to go. (NOTE: Sheets before 2019 use different formats).
    We’re good until 2019.
  • Whether to only retrieve events from the DB when building next.angular.io on upstream CI and get next.angular.io/generated.events.json for other builds.
    (This would allow us to lock down reading on the database fwiw.)
    We'll go with the current implementation for simplicity. We can revisit in the future if the number of reads becomes problematic.

TODO

  • Set up Apps Script extension on the actual spreadsheet and create time-driven trigger.
  • Ensure the installable trigger creator has access to the angular-io Firebase project.
  • Update DB_URL value in constants.js and index.mjs.
  • Rework some parts of the implementation - see here.
    PR: feat(github-actions): implement GitHub Action for creating a PR from local changes dev-infra#738
  • List specific ways to get in touch with DevRel in aio/content/marketing/events-contributing.md.
  • Link to the GitHub Action that periodically updates events in aio/scripts/generate-events/README.md.
  • Address TODOs in .github/workflows/update-events.yml.
  • Update payload sizes in aio-payloads.json.

@mary-poppins
Copy link

You can preview 6ca41c3 at https://pr45588-6ca41c3.ngbuilds.io/.

@ngbot ngbot bot added this to the Backlog milestone Apr 11, 2022
@gkalpak gkalpak added area: build & ci Related the build and CI infrastructure of the project action: review The PR is still awaiting reviews from at least one requested reviewer target: patch This PR is targeted for the next patch release and removed comp: docs labels Apr 11, 2022
@gkalpak gkalpak marked this pull request as ready for review April 11, 2022 19:18
@pullapprove pullapprove bot requested a review from mgechev April 11, 2022 19:18
@mary-poppins
Copy link

You can preview 832adb0 at https://pr45588-832adb0.ngbuilds.io/.

@mary-poppins
Copy link

You can preview a551b54 at https://pr45588-a551b54.ngbuilds.io/.

Copy link
Member

@mgechev mgechev left a comment

Choose a reason for hiding this comment

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

Left two comments. Looks really well!

jessicajaniuk
jessicajaniuk previously approved these changes Apr 11, 2022
Copy link
Contributor

@jessicajaniuk jessicajaniuk left a comment

Choose a reason for hiding this comment

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

reviewed-for: size-tracking

@mary-poppins
Copy link

You can preview ed461dc at https://pr45588-ed461dc.ngbuilds.io/.

@gkalpak gkalpak requested a review from mgechev April 16, 2022 15:01
mgechev
mgechev previously approved these changes Apr 18, 2022
@mary-poppins
Copy link

You can preview fcce55c at https://pr45588-fcce55c.ngbuilds.io/.

@mary-poppins
Copy link

You can preview c4cb9f7 at https://pr45588-c4cb9f7.ngbuilds.io/.

@gkalpak gkalpak force-pushed the build-aio-revamp-events branch 2 times, most recently from 7ea2e24 to 8573647 Compare August 26, 2022 20:19
@mary-poppins
Copy link

You can preview 8573647 at https://pr45588-8573647.ngbuilds.io/.

@gkalpak gkalpak force-pushed the build-aio-revamp-events branch 2 times, most recently from 581ed52 to 9ec7d45 Compare August 26, 2022 20:51
@gkalpak gkalpak marked this pull request as ready for review August 26, 2022 20:52
@pullapprove pullapprove bot removed the request for review from atscott August 26, 2022 20:52
…events page

This commit introduces a new process for generating data for the AIO
[events page](https://angular.io/events), which streamlines the process
and minimizes duplication and manual work. For more details, see
`aio/scripts/generate-events/README.md`.
@mary-poppins
Copy link

You can preview 9ec7d45 at https://pr45588-9ec7d45.ngbuilds.io/.

@gkalpak gkalpak added action: merge The PR is ready for merge by the caretaker and removed action: review The PR is still awaiting reviews from at least one requested reviewer labels Aug 26, 2022
@AndrewKushnir AndrewKushnir added the merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note label Sep 7, 2022
@AndrewKushnir
Copy link
Contributor

Merge-assistance: needs a "green light" from @mgechev before landing this PR.

@AndrewKushnir AndrewKushnir added action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews and removed action: cleanup The PR is in need of cleanup, either due to needing a rebase or in response to comments from reviews labels Sep 7, 2022
@AndrewKushnir
Copy link
Contributor

Got a "green light" from @mgechev offline, so we can proceed with merging this PR. // cc @dylhunn

@dylhunn
Copy link
Contributor

dylhunn commented Sep 12, 2022

This PR was merged into the repository by commit c9241fd.

@dylhunn dylhunn closed this in c9241fd Sep 12, 2022
dylhunn pushed a commit that referenced this pull request Sep 12, 2022
…events page (#45588)

This commit introduces a new process for generating data for the AIO
[events page](https://angular.io/events), which streamlines the process
and minimizes duplication and manual work. For more details, see
`aio/scripts/generate-events/README.md`.

PR Close #45588
@gkalpak gkalpak deleted the build-aio-revamp-events branch September 12, 2022 19:44
@dylhunn
Copy link
Contributor

dylhunn commented Sep 13, 2022

@gkalpak Was this PR related to update-events.yml? I have started getting emails that the Update AIO events script has failed to run, with links like this one.

@gkalpak
Copy link
Member Author

gkalpak commented Sep 14, 2022

Yes. As discussed "offline", notifications for scheduled workflows go to the last person that modified the schedule: GitHub docs

Once the errors are fixed, hopefully there won't be any notifications 😁

vyom1611 pushed a commit to vyom1611/angular that referenced this pull request Sep 18, 2022
…events page (angular#45588)

This commit introduces a new process for generating data for the AIO
[events page](https://angular.io/events), which streamlines the process
and minimizes duplication and manual work. For more details, see
`aio/scripts/generate-events/README.md`.

PR Close angular#45588
@angular-automatic-lock-bot
Copy link

This issue has been automatically locked due to inactivity.
Please file a new issue if you are encountering a similar or related problem.

Read more about our automatic conversation locking policy.

This action has been performed automatically by a bot.

@angular-automatic-lock-bot angular-automatic-lock-bot bot locked and limited conversation to collaborators Oct 15, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
action: merge The PR is ready for merge by the caretaker area: build & ci Related the build and CI infrastructure of the project merge: caretaker note Alert the caretaker performing the merge to check the PR for an out of normal action needed or note target: patch This PR is targeted for the next patch release
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants