# -- Project information -----------------------------------------------------

  project = 'ARC notes'

  author = 'Fedora-Infra'

  User stories

  ============

  Following is the investigation on GitLab based on the user stories collected.

  1.  **As a package maintainer, I'd like to be able to run my own CI jobs on distgit PRs.**

  2.  **As a package maintainer, I'd like to be able to control the-new-hotness monitoring status from distgit.**

  3.  **As a provenpackager, I should have push and merge access to all packages in the Fedora package collection.**

  4.  **As a package maintainer and Fedora tooling maintainer, I'd like to be able to use Packit in both distgit and upstream repositories.**

  5.  **As a package maintainer, I'd like to have easy access links to Koji, Bodhi, and Koschei from the distgit repo.**

  6.  **As a packager sponsor/mentor, I'd like to help users from outside the packager make their first PR without requiring special tooling or authentication schemes.**

  7.  **As a package maintainer and tooling maintainer, I'd like to be able to set Depends-on: and Blocks: relationships between tickets in the issue tracker.**

  8.  **As a package maintainer, I'd like to continue to be able to use fedpkg to fork repositories and otherwise interact with distgit.**

  9.  **As a package maintainer, I want to be able to control all aspects of the pull request process (read comments, reply to comments, approve PRs, merge PRs, etc) via an REST API to allow creation command line tools to automate work that otherwise requires a pointy-clicky web UI.**

  10.  **As a package maintainer, I want to be able to mark a PR to automatically merge if-and-only-if a running CI pipeline has succeeded. This allows reviewing and approving a PR, and moving onto new work, without having to wait around to see if CI passes or not. The PR only needs re-visiting manually if CI failed.**

  11. **As a contributor, I want to be able to see who the current maintainer(s) are for a package.**

  12. **As a contributor, I want to be able to request to join the maintainer(s) for a package, either as a watcher (just notified of all PRs), or as a developer (participate in MR process), or as a maintainer (control all aspects of the package, ie user ACLs). Joining as merely a watcher should not require approval by current maintainers.**

  13. **As a package maintainer, I want opening a MR to automatically create a scratch-build. Approving the MR, should be able to either automatically promote the scratch-build to non-scratch status, or create a new non-scratch build. The latter should have a way to disable for packages with huge build times where creation of one build for multiple approved MRs is desirable for efficiency.**

  14. **As a package maintainer, I would like to see the dependencies of this package, and what packages that are required by this package on web UI.**

  15. **As a contributor, I want to be able to see who the current maintainer(s) are for a package.**

  16. **As a contributor, I want to be able to see the contributors that have contributed to this package.**

  17. **"As a packager I want to be able to have commit access without being added to the bugzilla watch list.**

  18. **As a community member I want the ability to be added to the bugzilla watch list for a package without having commits or being in the packager group.**

  19. **As a Fedora Infrastructure member, I want to ensure people who sign in to watch a package on bugzilla have a valid bugzilla account associated with their FAS account.**

  20. **As a user of Fedora, not necessarily a member of the Fedora Project, I want to receive information about Fedora packages in the form of readable HTML documents, not in the form of programs (in Javascript or Web Assembly) that I must execute before I get to see the information.**

  21. **As a security-conscious packager, I want to interact with the web interface without downloading and running programs from a bunch of third parties. I should at most need to whitelist Javascript and Web Assembly from fedoraproject.org only.**

  22. **As a member of the Free Software movement, I want all parts of the system to be Free Software. That includes both server-side software and all Javascript, Web Assembly and/or CSS that my browser will download and execute.**

  23. **As a package maintainer, I want to be able to use a pull-request-only workflow for specific packages (like packages that could break a lot of things, or packages that are security sensitive).**

  24. **As a package maintainer with provenpackager or scm-admin rights, I want to be able to circumvent pull-request-only requirements on packages when pushing changes (i.e. mass rebuilds).**

  25. **As a package maintainer, I'd like existing STI and TMT CI tests to continue working while also providing a simpler, more familiar YAML-based format.**

  26. **As a package maintainer, I want to be able to prevent direct push to git, and using merge requests process only.**

  27. **As a package maintainer, I want to be able to deal with bugs directly from the forge, and be able to reassign them between projects.**

  28. **As a package maintainer, I want to be able to sync a fork with the upstream with a button click.**

  29. **As a package maintainer, I wish we had CI compatible with Github Actions.**

  30. **As a contributor, I'd like to be able to interact with git and distgit via email, namely to reply to issue and PR comments.**

  31. **A contributor, I'd like to be able to create repositories under a personal namespace for work related to Fedora.**

  32. **As a package maintainer, I'd like to block branch creation outside of official ones, or remove branches outside of official ones.**

  33. **As a contributor, I'd like the forge to be accessible (alt text for images, respecting whatwg standards for contrast, color blindness, aria support).**

  34. **As a package maintainer I'd like to be able to delete a wrong file from the look aside cache.**

  35. **As a package maintainer, I'd wish to be able to see a tree of the Depends-on and Blocks bugs relationship, and export it to JSON or any easily processable document.**

  36. **As a package maintainer, I wish to have a Security tab listing known CVE, and dependencies known CVE for the package.**

  37. **As a package maintainer, I still want to be able to use Grokmirror to mirror the Forge packages locally.**

  38. **As an engineer involved in the release process, I want to be able to track blocker bugs and freeze exception bugs in the chosen issue tracker.**

  39. **As an engineer involved in the release process, I want to be able to properly triage the state of the blocker bugs and freeze exception bugs with Kanban boards.**

  40. **As an engineer involved in the release process, I should be able to notify the affected package maintainers and package testers.**

  41. **As an engineer involved in the release process, I want to be able to plan for the effects on release phases (Alpha, Beta, Final) using the Gantt chart.**

  42. **As an engineer involved in the release process, I want to be able to control the automated building and testing using comments.**

  43. **As an engineer involved in the release process, I want to be able to triage the priorities of the blocker bugs and freeze exception bugs in the chosen issue tracker.**

  44. **As an engineer involved in the release process, I want to be able to speed up the creation of blocker bugs and freeze exception bugs with the use of issue ticket templates.**

  45. **As an engineer involved in the release process, I want to be able to limit the access of ticket modification to a certain set of people.**

  46. **As an engineer involved in the release process, I want to be able to access the chosen issue tracker with the use of an HTTP API.**

  47. **As an engineer involved in the release process, I want to be able to show related issue tickets to the reporter to avoid repeated rejections.**

  48. **As an engineer involved in the release process, I want to be able to use the already established Bug Status Workflow as closely as possible.**

  49. **As an engineer involved in the release process, I want to be able to automate ticketing workflows according to the phases of a release.**

  50. **As an engineer involved in the release process, I want to be able to track accepted previous release blocker bugs in the chosen issue tracker.**

  51. **As a consumer of the fedora messaging bus, I want to be able to continue to receive messages in a JSON format on events.**

  52. **As a developer/release engineer/QA/contributor, we need the new dist-git service to have hooks to attach new and existing CI pipelines.**

  53. **As a contributor, I need to be able to login using my Fedora account.**

  54. **As a developer, I would like there to be a separate staging and production instance of dist-git so I can test my changes before pushing them.**

  55. **As a maintainer of dist-git(s), I would like to use industry-standard tools to maintain large files.**

  56. **As a maintainer, I would like an easy-to-use interface to make suggestions on individual code blocks and suggest changes that the submitter can simply apply.**

  57. **As a package maintainer, I would like to be able to automatically transfer issues between packages (for example from ansible -> ansible-core).**

  58. **A package maintainer, I would like a push hook to block pushes to retired or EOL branches**

  59. **As a package maintainer, I want to be able to grant access to specific branches, or branches matching a pattern, to individual users. In pagure this is referred to as collaborator access.**

  60. **As a policy enforcer, I want to be able to "orphan" packages that are not mine.**

  61. **As a developer, I want to be query packages by their maintainers and vice versa.**

  62. **As a packager, I need the new forge to support the orphaned packages process: a maintainer should be able to automatically orphan a package they own and another packager should be able to take ownership through a self-service interface.**

  63. **As a package maintainer, I need the forge to allow me to push branches that do not share history with other branches.**

  64. **As a driveby contributor, who is not a provenpackager (or does not want to use their provenpackager rights), I need to be able to open a Pull Request/Merge Request which introduces zero code changes (it has only empty commit(s) to bump the release for packages using %autorelease).**

  65. **As a proven packager, I want to be able to do basic repo operations from the command line. For example, I have the following in my history fedpkg fork && git remote rename zbyszek my && git push my rawhide:bin-sbin-merge, which I used maybe a hundred times when working on packages for the bin-sbin merge. I would then click on the link printed by the push command and review the diff before submitting a pull request and possibly adjust the commit message. Generalizing from this, all operations like forking, merging and closing of pull requests, should be possible via a command line tool. The tool must also be packaged in Fedora.**

  66. **As a documentation contributor, I would love to try out new Git forge test systems. I'm agnostic to tools, so I believe I can spend time on UX and docs workflow (build, preview, issue tracking, GitHUb Action-like features and so on).**

  67. **As a member of the CDT team I need to be able to get notified automatically when someone opens a design request. (An email will be sent to a mailing list).**

  68. **As a member of release engineering, I need to be able to enforce that all repos in dist-git disallows the rewriting of history. (There's nuance here; it might be okay to allow rewriting on non-standard branches, but we'd need a way to confirm that none of the affected commits were ever used to perform an official build. This is probably more effort than it's worth vs simply disallowing rewriting on any branch)**

  69. **As a packager/user, I'd like to be able to easily determine which commits were used in the creation of particular Fedora builds. A preferred mechanism for this would be to have hooks in place that can automatically commit git tags (signed with an official GPG signature) indicating associated NVRs.**

  70. **As a packager, I'd like to be able to use "draft builds" in merge requests that are then promoted to official builds when the MR is merged. This is to ensure that the build that was tested and approved in the MR is the same one that gets submitted as an erratum.**

  71. **As a packager, I'd like the option to have packages submitted as an erratum automatically when a merge request is merged. Ideally, this would be supplemental to the above "draft builds", just submitting that exact build to errata.**

  72. **As a packager, I'd like to be able to provide my own test pipelines for merge requests on individual projects (supplemental to any standard tests provided and/or required by Fedora).**

  73. **As a member of Fedora Quality, I need to be able to transparently move any ticket opened by any user for one package to another package and preserve history.**

  74. **As a member of Fedora Quality, I would like to be able to define ticket submission form templates with custom fields. And create input validations and query all opened tickets based on those field definitions.**

  75. **As a member of Fedora Quality, I need to be able to specify "need_info" on a specific ticket. This function should regularly ping (email/matrix or any other channels) the specified user that I am requesting information from.**

  76. **As a policy enforcer, I need to be able to get all the information about a ticket/issue/bug from a Python script in a structured way.**

  77. **As a policy enforcer, I need to be able to open/modify/comment on a ticket/issue/bug from a Python script (including all the possible metadata).**

  78. **As a policy designer, I need to be able to add custom and structured metadata to a ticket/issue/bug, in the form of key=value pairs. I need to be able to set rules for individual keys (such as which values are valid).**

  79. **As a package maintainer, I want to have syntax highlighting for RPM spec files in the git forge web interface. Currently Pagure and Forgejo have this, but GitLab does not.**

  80. **As a Fedora Badges junkie, I want to be able to receive badges for activities related to dist-git. In technical terms, the dist-git activities must be broadcast to the Fedora Message Bus (or however it's called nowadays).**

  81. **Scalability - As a SaaS administrator, I want the system architecture to support scalability, manually or automatically based on demand, so that we can maintain optimal performance during traffic spikes and efficiently handle user growth.**

  82. ** Reliability and High Availability - User Story: As a SaaS administrator, I want the service architecture to be highly available, to ensure 24/7 operation with minimal downtime, so that end users may access and use the application whenever needed without interruptions.**

  83. **Security - User Story: As a SaaS administrator, I want robust security measures implemented across our infrastructure, including encryption, access controls, and regular security audits, so that we can protect our end users data and maintain their trust.**

  84. **Security - User Story: As a SaaS administrator, I want to quickly identify when the system is affected by CVEs, so that steps can be taken to plan upgrades to mitigate vulnerabilities.**

  85. **Monitoring and Observability - User Story: As a SaaS administrator, I want a centralised monitoring and logging system that provides real-time insights into application performance, resource utilisation, and user experience, so that we can quickly identify and resolve issues before they impact users.**

  86. **Infrastructure as Code (IaC) - User Story: As a SaaS administrator, I want to manage our the system infrastructure using code that we can version control, easily replicate environments, and automate provisioning and configuration.**

  87. **Multi-tenancy - User Story: As a SaaS administrator, I want the application to be a secure multi-tenant system that efficiently shares resources among end users while ensuring complete data isolation, so that we can serve multiple clients cost-effectively without compromising security.**

  88. **Disaster Recovery and Backup - User Story: As a SaaS administrator, I want automated backup systems and a comprehensive disaster recovery plan in place, so that we can quickly recover from any unforeseen events and minimise data loss and downtime.**

  89. **Upgradability - User Story: As a SaaS administrator, I want to apply automated system upgrades, preferrably without causing system downtime, so we can continue to provide service to end users.**

  90. **Upgradability - User Story: As a SaaS administrator, I want to safely apply database schema upgrades without causing outages or data loss.**

  91. **As a maintainer of packages in Fedora, I would like the ability to move a ticket assigned to my project to a new project. As an example, . I get a few tickets every month against "fedora-release" because people just use that as a stand-in for "I don't know what package to report against"**

  92. **As a Fedora CI maintainer, I would like to have the ability to enable mandatory checks for each dist-git pull request to ensure Fedora distribution stability.**

  93. **As a Fedora forge administrator, I would like to have legally-enforceable assurances that features available in the open-source (or "community edition") of the forge will remain that way in the future in order to prevent platform decay from degrading the functionality.**

  USER

  ^^^^

  The table stores information of all the users enrolled to the service. For the

  most parts, the service will make use of Fedora Account System authentication

  While most users will have basic privileges of utilizing the service, some

  users will have elevated privileges of maintaining the service.

  The following keys must be populated in order to create an entry to the table.

     moderate the users and establish fair usage. The data type considered here

     is boolean.

  As this table does not depend on any other table, it does not have any foreign

  keys.

  The ``UUID`` key is the primary key for the table.

  APIKEY

  ^^^^^^

  The table stores information of all the access tokens associated per entry on

  the user table. The access token is required to authenticate the user

  purpose of the created access token, set the validity of the same and revoke

  its usage in their discretion and these would be recorded.

  The following keys must be populated in order to create an entry to the table.

     to protect or invalidate existing API keys. The data type considered here

     is boolean.

  This table depends on the user table and hence, it has one foreign key named

  ``USER_UUID`` referencing the key ``UUID`` from the user table.

  The ``UUID`` key is the primary key for the table.

  SERVICE

  ^^^^^^^

  The table stores information of all the service entries associated per entry on

  the user table. A POST endpoint with the unique identifier as the route string

  service, templatable topic, templatable body, creation date and revocation

  status can be managed by the users and are recorded.

  The following keys must be populated in order to create an entry to the table.

     populated with the creation date by fixture. The data type considered here

     is datetime.

  This table depends on the user table and hence, it has one foreign key named

  ``USER_UUID`` referencing the key ``UUID`` from the user table.

  The ``UUID`` key is the primary key for the table.

  MESSAGE

  ^^^^^^^

  The table stores information of all the message entries associated per entry on

  the service table. As the contents of the message can be easily retrieved from

  created only when the messages originating from service events being triggered

  are shared on the Fedora Messaging bus successfully.

  The following keys must be populated in order to create an entry to the table.

     populated with the creation date by a fixture. The data type considered

     here is datetime.

  This table depends on the service table and hence, it has one foreign key named

  ``SERVICE_UUID`` referencing the key ``UUID`` from the service table.

  The ``UUID`` key is the primary key for the table.

  Message producer

  ================