[RFC0023] GitHub Action to update Catalog Weekly

[Zakongjampa]

Table of Contents

• Housekeeping
• Named Concepts
• Summary
• Reference-Level Explanation
• Alternatives
  • Rationale
• Drawbacks
• Useful References
• Unresolved questions
• Parts of the system affected
• Future possibilities
• Infrastructure
• Testing
• Documentation
• Version History
• Recordings
• Work Phases

Housekeeping

[RFC0023] GitHub Action to update Catalog Weekly

ALL BELOW FIELDS ARE REQUIRED

Named Concepts

• GitHub API for python
• GitHub Action

Summary

Under the OpenPecha-data, they are many Pechas that are kept in the archive hence to access those Pecha from one file, we need a catalog. Which has all the Pecha_id and links to access the Pecha from the BDRC website.
All the catalog data should be unique. Any new Pecha that has been added must fetch the detail by the catalog weekly and save the details in the catalog.csv file.

Reference-Level Explanation

Everyday developer will work on Pecha and generate metadata of the Pechas, bringing new Pecha onto the OpenPecha platform, etc. Thus, we need a catalog that will update itself every week so that all the new Pecha that we have added this week will get updated in the catalog automatically by using the GitHub Action. GitHub Action is a continuous integration and continuous delivery (CI/CD) platform that allows you to automate your build, test, and deployment pipeline. Here we are using the GitHub Action to read all the metadata and generate a catalog file that contains information like pecha_id, title, volume, author, source id, creation date, and legacy id. With this program running behind we will have a catalog file that contains all the information without duplication and will be up to date every week.

Alternatives

Rationale

• Why the currently proposed design was selected over alternatives?
• What would be the impact of going with one of the alternative approaches?
• Is the evaluation tentative, or is it recommended to use more time to evaluate different approaches?

Drawbacks

Describe any particular caveats and drawbacks that may arise from fulfilling this particular request?

Useful References

Describe useful parallels and learnings from other requests, or work in previous projects.

• What similar work have we already successfully completed? : This GitHub Action cataloging weekly has been developed but right now due to some issues. It has stoped working.
• Is this something that have already been built by others? : I will resolve the current issue.
• What other related learnings we have? : None
• Are there useful academic literature or other articles related with this topic? (provide links)
• Have we built a relevant prototype previously? : None
• Do we have a rough mock for the UI/UX? : None required
• Do we have a schematic for the system? : None

Unresolved Questions

• What is there that is unresolved (and will be resolved as part of fulfilling this request)?
• Are there other requests with same or similar problems to solve?

Parts of the System Affected

• Which parts of the current system are affected by this request?
• What other open requests are closely related with this request?
• Does this request depend on fulfillment of any other request?
• Does any other request depend on the fulfillment of this request?*

Future possibilities

How do you see the particular system or part of the system affected by this request be altered or extended in the future.

Infrastructure

Describe the new infrastructure or changes in current infrastructure required to fulfill this request.

Testing

Describe the kind of testing procedures that are needed as part of fulfilling this request.

Documentation

Describe the level of documentation fulfilling this request involves. Consider both end-user documentation and developer documentation.

Version History

v.0.1

Recordings

Links to audio recordings of related discussion.

Work Phases

• Download the GitHub Repo from GitHub
  time estimate: 30 min
  time taken:
• Parse catalog.csv from catalog repo to get the list of existing Pechas.
  time estimate: 30 min
  time taken:
• Make a list of all the Pecha currently present in OpenPecha-data.
  time estimate: 30 min
  time taken:
• Compare the above two lists to get new Pecha_ids.
  time estimate: 30 min
  time taken:
• Get the Pecha info of the new Pecha_ids.
  time estimate: 30 min
  time taken:
• Update all the new Pecha info into the catalog.csv
  time estimate: 30 min
  time taken:
• Push the updated catalog.csv to catalog Repo.
  time estimate: 30 min
  time taken:

Non-Coding

Keep original naming and structure, and keep as first section in Work phases section

• Planning
• Documentation
• Testing