Update wins Google Apps Script to format wins json feed

[roslynwythe]

Dependency

• Add latest version of Google Apps Scripts to GitHub #3641
• Create wiki page "Hfla Google Apps Script Development/Review Process" #4134
• Add new section "Testing Wins in a test repository" to the Wins Apps Script Development Wiki Page #5746

Overview

Currently the wins JSON feed contains no line breaks or spaces separating elements and so it is difficult to review Pull Requests for wins data updates. By formatting the JSON with each submission on a separate line and with use of spaces to indent, readability will be improved and JSON feeds could be compared more efficiently.

Action Items

• Request VIEW access to the Wins Form Admin Guide Doc, the Wins-form (Response) Sheet, and gh-requests Doc from the dev lead
• Read the Wins Form Admin Guide to understand the flow of wins data.
• This issue will require modification of the code within the Wins-form (responses) sheet, but you will require a test environment that includes copies of Wins-form (Responses) and gh-requests. It will also be necessary to setup a test environment in your GitHub repository. Follow instructions in the comment in the Hfla Google Apps Script Development Guide¹ and Testing WINS in a test repository²
• Once you have made copies of the required documents, let the dev lead know that access can be ended.
• In the Google Apps Script module Code.gs in the project WinsFormResponse, which is bound to Wins-form (Responses) Sheet, update main() to format the _wins-data.json feed, either using options built into the JSON.stringify method, or a different method. Required features are:
  • Line Breaks separating array items (where each array item represents the data for a contributor)
  • Line Break with spaces indenting properties within each array item
• Test the code by running main() in debug mode. A new pull request "Update wins-data.json via Google Apps Script" should be appear in your test repository. Examine the json data and if it looks good, merge into your repository test branch and examine the resulting Wins page.
• Add/commit Code.js and create a pull request as usual
• In the pull request, provide links to the "Update wins-data.json via Google Apps Script" Pull Request and also the Wins page (both in your repository), for the convenience of reviewers.
• Contact a dev lead to discuss review/demonstration

Dev Lead

• Remove VIEW access to all protected documents

Resources/Instructions

• sample PR for updating wins data Update wins-data.json via Google Apps Script #4029
• (Create wiki page "Hfla Google Apps Script Development/Review Process" #4134 (comment))
• Wins data (json)
• Wins webpage
• wins.html
• Wins js

Footnotes

1. Hfla Google Apps Script Development Guide - draft ↩

2. Testing WINS in a test repository ↩

[roslynwythe]

@ExperimentsInHonesty For security reasons, I did not provide links to the Google Apps Scripts. The dev lead will know where they are.

• I applied the Time Sensitive label because an issue has come up with merge conflicts in recent the Wins Update wins-data.json via Google Apps Script #5767 and it is difficult to solve without being able to do a line by line comparison.

[github-actions]

Hi @Jung-GunSong, thank you for taking up this issue! Hfla appreciates you :)

Do let fellow developers know about your:-
i. Availability: (When are you available to work on the issue/answer questions other programmers might have about your issue?)
ii. ETA: (When do you expect this issue to be completed?)

You're awesome!

P.S. - You may not take up another issue until this issue gets merged (or closed). Thanks again :)

[Jung-GunSong]

i. From today, 1/24/24 to next week, 1/31/24.

ii. Likely by next week (unsure because some guidance might be needed to set up the test environment).

As always, let me know if there's anything else I can help with!