SoK/2023/StatusReport/Neelaksh Singh: Difference between revisions

Revision as of 11:21, 13 April 2023

Systematization 1: Automate Flatpak checks in GitLab Invent CI

Adding Flatpak CI/CD to Application Repository

Project type: CI/CD pipeline | Script | Documentation

Introduction and Abstract: Currently only one computer program in the Global Ecolabelling Network is certified with the Blue Angel ecolabel: KDE's Okular. As part of the new sustainability goal, we would like to add more KDE apps, in particular GCompris and Kate, to the list.

To obtain the Blue Angel ecolabel, applications must demonstrate compliance with a list of criteria, including energy consumption transparency and user autonomy. KDE has an advantage here, since being Free Software we are already fulfilling many aspects of the criteria. The candidate will be responsible for completing what is needed to submit at least two applications for Blue Angel eco-certification, including (a) updating online documentation for the user autonomy criteria for GCompris and Kate, and (b) testing usage scenario scripts before the software can be measured in the community lab.

Mentor: Timothée Ravier (@siosm:matrix.org) Aleix Pol (@apol:kde.org)

Blog Posts:

CI/CD with Flatpak

Files and Links

HackMD

Apps with successful flatpak pipeline and Nightly Builds

Weekly Progress

WEEKS 1 - 3: I started by getting acquainted with the KDE community and learning about Flatpak Packaging. I also familiarized myself with the Flathub ecosystem and understanding the key aspects missing in the manifests present in the flatpak repository. We discussed PoA for getting the correct manifest files, standardized approach for adding them to respective applications and adding the necessary license file. We decided upon the distribution of work in phases and created the hackmd file for tracking changes and updates.

WEEKS 4 - 9: I stated to raise PR's for application with their respective flatpak manifest, along with license file. Also added the flatpak build pipeline to `.gitlab.ci`

WEEKS 10 - 12: Most of the days were spent in cleaning up the files and getting regular updates on the merge status. I focused on writing blog as well as including the nightly builds for the application that were successfully building the

CONTACT ME: Matrix: @neelaksh:matrix.org

@@ Line 1: / Line 1: @@
 [https://community.kde.org/SoK/Ideas/2023#Systematization_1:_Automate_Flatpak_checks_in_GitLab_Invent_CI Systematization 1: Automate Flatpak checks in GitLab Invent CI]
-[https://rinkiakepapa.hashnode.dev/cicd-with-flatpak Blog]
+== Adding Flatpak CI/CD to Application Repository ==
+'''Project type:'''
+CI/CD pipeline | Script | Documentation
+'''Introduction and Abstract:'''
+Currently only one computer program in the Global Ecolabelling Network is certified with the Blue Angel ecolabel: [https://eco.kde.org/blog/2022-03-16-press-release-okular-blue-angel/ KDE's Okular]. As part of the new [https://community.kde.org/Goals/Sustainable_Software sustainability goal], we would like to add more KDE apps, in particular GCompris and Kate, to the list.
+To obtain the Blue Angel ecolabel, applications must demonstrate compliance with a list of criteria, including energy consumption transparency and user autonomy. KDE has an advantage here, since being Free Software we are already fulfilling many aspects of the criteria. The candidate will be responsible for completing what is needed to submit at least two applications for Blue Angel eco-certification, including (a) updating online documentation for the [https://mail.kde.org/pipermail/energy-efficiency/2021-September/000025.html user autonomy criteria] for GCompris and Kate, and (b) testing usage scenario scripts before the software can be measured in the [https://eco.kde.org/blog/2022-07-25-sprint-lab-follow-up/ community lab].
+'''Mentor:'''
+Timothée Ravier (@siosm:matrix.org)
+Aleix Pol (@apol:kde.org)
+'''Blog Posts: '''
+[https://rinkiakepapa.hashnode.dev/cicd-with-flatpak CI/CD with Flatpak]
+'''Files and Links'''
+[https://hackmd.io/@travier/rJojD9xMi HackMD]
+[https://invent.kde.org/packaging/flatpak-kde-applications/-/merge_requests/115 Apps with successful flatpak pipeline and Nightly Builds]
+===== Weekly Progress =====
+'''WEEKS 1 - 3:'''
+I started by getting acquainted with the KDE community and learning about Flatpak Packaging. I also familiarized myself with the Flathub ecosystem and understanding the key aspects missing in the manifests present in the flatpak repository. We discussed PoA for getting the correct manifest files, standardized approach for adding them to respective applications and adding the necessary license file. We decided upon the distribution of work in phases and created the hackmd file for tracking changes and updates.
+'''WEEKS 4 - 9:'''
+I stated to raise PR's for application with their respective flatpak manifest, along with license file. Also added the flatpak build pipeline to `.gitlab.ci`
+'''WEEKS 10 - 12:'''
+Most of the days were spent in cleaning up the files and getting regular updates on the merge status. I focused on writing blog as well as including the nightly builds for the application that were successfully building the
+'''CONTACT ME:'''
+Matrix: @neelaksh:matrix.org