Skip to content

Suggest Unpacking the Latest Version Files to a New Branch to Enhance Developer Experience and Enable GitHub Features #10

@fredgan

Description

@fredgan

Problem Description:

Currently, all historical release ZIP files are stored in different directories. This approach is not developer-friendly because it leads to the following issues:

  • Inability to Intuitively See the Latest Code: Developers cannot directly view the most recent code files in the repository's main view, making it difficult to quickly understand the current state of the project.
  • Inability to Review Code and Submit Pull Requests: Since the latest code is not in a standard branch, developers cannot perform code reviews, suggest changes, or submit Pull Requests in the usual workflow.
  • Difficulty in Comparing Differences Between Releases: Comparing two different releases to understand new features or changes is cumbersome, requiring downloading and manually comparing ZIP files.
  • GitHub Security Scan (SAST) Cannot Function Properly: The security scan feature (Static Application Security Testing) provided by GitHub cannot effectively analyze the code under this directory storage mode.
  • GitHub Actions (CI/CD) Cannot Be Used: The lack of a standard branch containing the latest code prevents the utilization of GitHub Actions for continuous integration and other automation processes.

Proposed Solution:

To address the aforementioned problems and enhance the developer experience, we suggest unpacking the files from the latest version's ZIP file into a new branch.

Benefits of the Proposed Solution:

  • Intuitive Access to the Latest Code: Developers can easily view and work with the most recent codebase directly within the repository.
  • Enabled Code Review and Pull Request Functionality: Standard development workflows for code review and Pull Request submission will be enabled.
  • Simplified Release Comparison: Comparing differences between releases will be much easier using GitHub's comparison tools.
  • Enabled GitHub Security Scan: GitHub's security scan feature will be able to analyze the latest code, improving code security.
  • Usability of GitHub Actions: GitHub Actions can be configured for automated builds, tests, deployments, etc., enhancing development efficiency.

Specific Recommendation:

Create a new branch, for example, named latest or release-latest, and unpack the contents of the most recent release ZIP file into this branch.

Metadata

Metadata

Assignees

Labels

No labels
No labels

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions