Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[PM-15176] Improve release processing and commit message generation #118

Merged
merged 1 commit into from
Dec 11, 2024
Merged

[PM-15176] Improve release processing and commit message generation #118

merged 1 commit into from
Dec 11, 2024
+89 −81

Conversation

SaintPatrck
Copy link
Contributor

@SaintPatrck SaintPatrck commented Dec 11, 2024 •
edited
Loading

🎟️ Tracking

PM-15176

📔 Objective

This commit introduces several improvements to the release processing and commit message generation:

  • Process a maximum of 10 latest releases per app to prevent back-filling of legacy releases.
  • Skip releases if the APK already exists for the given version.
  • Refactor the commit message format to provide a more comprehensive overview of the updates:
    • Includes a clear title with the list of updated repos.
    • Organizes the body with sections for each repo, providing links to relevant resources.
    • Explicitly marks the latest release for each app within the repo section.
    • Groups metadata updates into a dedicated section with a collapsible summary for readability.
  • Fix a case where changes to only index files were being ignored. Now, metadata-only changes will trigger a commit.
  • Include updates to repository metadata files when they have been made.

📸 Screenshots

Updated apps from bitwarden/android
  
  ## Updated repositories
  ## [bitwarden/android](https://github.com/bitwarden/android)
  ### Apps
  <details>
  <summary>Bitwarden Beta</summary>
    - [2024.11.7 (19528)](https://github.com/bitwarden/android/releases/tag/v2024.11.7) **latest**
    - [2024.11.6 (19499)](https://github.com/bitwarden/android/releases/tag/v2024.11.6)
    - [2024.11.5 (19461)](https://github.com/bitwarden/android/releases/tag/v2024.11.5)
    - [2024.11.4 (19444)](https://github.com/bitwarden/android/releases/tag/v2024.11.4)
    - [2024.11.2 (19430)](https://github.com/bitwarden/android/releases/tag/v2024.11.2)
    - [2024.11.0 (19421)](https://github.com/bitwarden/android/releases/tag/v2024.11.0)
    - [2024.10.1 (19388)](https://github.com/bitwarden/android/releases/tag/v2024.10.1)
  </details>
  
  <details>
  <summary>Bitwarden</summary>
    - [2024.11.7 (19528)](https://github.com/bitwarden/android/releases/tag/v2024.11.7) **latest**
    - [2024.11.6 (19499)](https://github.com/bitwarden/android/releases/tag/v2024.11.6)
    - [2024.11.5 (19461)](https://github.com/bitwarden/android/releases/tag/v2024.11.5)
    - [2024.11.4 (19444)](https://github.com/bitwarden/android/releases/tag/v2024.11.4)
    - [2024.11.2 (19430)](https://github.com/bitwarden/android/releases/tag/v2024.11.2)
    - [2024.11.0 (19421)](https://github.com/bitwarden/android/releases/tag/v2024.11.0)
    - [2024.10.1 (19388)](https://github.com/bitwarden/android/releases/tag/v2024.10.1)
  </details>
  
  ## Metadata updates:
  
  We performed updates to repository metadata files.
  <details>
  <summary>See what changed</summary>
    - README.md
    - fdroid/archive/diff/1731294285000.json
    - fdroid/archive/entry.jar
    - fdroid/archive/entry.json
    - fdroid/metadata/com.x8bit.bitwarden.beta.yml
    - fdroid/metadata/com.x8bit.bitwarden.yml
    - fdroid/repo/bitwarden-beta_v2024.7.3.apk
    - fdroid/repo/bitwarden-beta_v2024.8.0.apk
    - fdroid/repo/bitwarden-beta_v2024.8.1.apk
    - fdroid/repo/bitwarden-beta_v2024.9.0.apk
    - fdroid/repo/bitwarden_v2024.5.1.apk
    - fdroid/repo/bitwarden_v2024.6.0.apk
    - fdroid/repo/bitwarden_v2024.7.2.apk
    - fdroid/repo/bitwarden_v2024.7.3.apk
    - fdroid/repo/bitwarden_v2024.8.0.apk
    - fdroid/repo/bitwarden_v2024.8.1.apk
    - fdroid/repo/bitwarden_v2024.9.0.apk
    - fdroid/repo/diff/1731294288000.json
    - fdroid/repo/entry.jar
    - fdroid/repo/entry.json
    - fdroid/repo/icons-160/com.x8bit.bitwarden.10574.png
    - fdroid/repo/icons-160/com.x8bit.bitwarden.10746.png
    - fdroid/repo/icons-240/com.x8bit.bitwarden.[1057](https://github.com/bitwarden/f-droid/actions/runs/12285372897/job/34283211246#step:16:1067)4.png
    - fdroid/repo/icons-240/com.x8bit.bitwarden.10746.png
    - fdroid/repo/icons-320/com.x8bit.bitwarden.10574.png
    - fdroid/repo/icons-320/com.x8bit.bitwarden.10746.png
    - fdroid/repo/icons-480/com.x8bit.bitwarden.10574.png
    - fdroid/repo/icons-480/com.x8bit.bitwarden.10746.png
    - fdroid/repo/icons-640/com.x8bit.bitwarden.10574.png
    - fdroid/repo/icons-640/com.x8bit.bitwarden.10746.png
    - fdroid/repo/icons/com.x8bit.bitwarden.10574.png
    - fdroid/repo/icons/com.x8bit.bitwarden.10746.png
</details>

⏰ Reminders before review

  • Contributor guidelines followed
  • All formatters and local linters executed and passed
  • Written new unit and / or integration tests where applicable
  • Protected functional changes with optionality (feature flags)
  • Used internationalization (i18n) for all UI strings
  • CI builds passed
  • Communicated to DevOps any deployment requirements
  • Updated any necessary documentation (Confluence, contributing docs) or informed the documentation team

🦮 Reviewer guidelines

  • 👍 (:+1:) or similar for great changes
  • 📝 (:memo:) or ℹ️ (:information_source:) for notes or general info
  • ❓ (:question:) for questions
  • 🤔 (:thinking:) or 💭 (:thought_balloon:) for more open inquiry that's not quite a confirmed issue and could potentially benefit from discussion
  • 🎨 (:art:) for suggestions / improvements
  • ❌ (:x:) or ⚠️ (:warning:) for more significant problems or concerns needing attention
  • 🌱 (:seedling:) or ♻️ (:recycle:) for future improvements or indications of technical debt
  • ⛏ (:pick:) for minor or nitpick changes

@SaintPatrck
[PM-15176] Improve release processing and commit message generation
2b066c2 
This commit introduces several improvements to the release processing and commit message generation:

- **Process a maximum of 10 latest releases per app** to prevent back-filling of legacy releases.
- **Skip releases if the APK already exists** for the given version.
- **Refactor the commit message format** to provide a more comprehensive overview of the updates:
    - Includes a clear title with the list of updated repos.
    - Organizes the body with sections for each repo, providing links to relevant resources.
    - Explicitly marks the latest release for each app within the repo section.
    - Groups metadata updates into a dedicated section with a collapsible summary for readability.
- **Fix a case where changes to only index files were being ignored.** Now, metadata-only changes will trigger a commit.
- **Include updates to repository metadata files** when they have been made.
@SaintPatrck SaintPatrck requested a review from a team as a code owner December 11, 2024 21:38
@github-actions GitHub Actions
Copy link

Logo
Checkmarx One – Scan Summary & Details – 626ae96d-9968-4055-abea-6387b6b820e8

No New Or Fixed Issues Found

@SaintPatrck
Copy link
Contributor Author

Dry run: https://github.com/bitwarden/f-droid/actions/runs/12285372897/job/34283211246#step:16:1011

@SaintPatrck SaintPatrck enabled auto-merge (squash) December 11, 2024 21:57
vvolkgang
vvolkgang approved these changes Dec 11, 2024
View reviewed changes
Copy link
Member

@vvolkgang vvolkgang left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👏🏾

@SaintPatrck SaintPatrck merged commit 5870e61 into main Dec 11, 2024
6 checks passed
@SaintPatrck SaintPatrck deleted the PM-15176/improve-release-processing branch December 11, 2024 22:32
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@vvolkgang vvolkgang vvolkgang approved these changes

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@SaintPatrck @vvolkgang