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.

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

configuration for release notes generation #874

Closed
wants to merge 23 commits into from

Conversation

MatteoGuarnaccia5
Copy link
Contributor

@MatteoGuarnaccia5 MatteoGuarnaccia5 commented Aug 12, 2024

Description

Added configuration for custom auto generated release notes.
Made relevant changes in documentation.

The same changes would need to be made in ims-api

Testing instructions

Add a set up instructions describing how the reviewer should test the code

  • Review code
  • Check Actions build
  • Review changes to test coverage
  • {more steps here}

Agile board tracking

closes #806

@MatteoGuarnaccia5 MatteoGuarnaccia5 added the enhancement Improved or refactored feature label Aug 12, 2024
Copy link

codecov bot commented Aug 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.15%. Comparing base (2fcbad3) to head (2957e12).
Report is 349 commits behind head on develop.

Additional details and impacted files
@@             Coverage Diff             @@
##           develop     #874      +/-   ##
===========================================
+ Coverage    96.19%   99.15%   +2.96%     
===========================================
  Files          138       72      -66     
  Lines        33685    16041   -17644     
  Branches      4914     2978    -1936     
===========================================
- Hits         32402    15905   -16497     
+ Misses        1275      132    -1143     
+ Partials         8        4       -4     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@MatteoGuarnaccia5
Copy link
Contributor Author

image

An example of what the changelog now looks like with the new config

@MatteoGuarnaccia5 MatteoGuarnaccia5 removed the enhancement Improved or refactored feature label Aug 12, 2024
@MatteoGuarnaccia5 MatteoGuarnaccia5 marked this pull request as ready for review August 12, 2024 14:13
Copy link
Collaborator

@joshuadkitenge joshuadkitenge left a comment

Choose a reason for hiding this comment

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

Here is a guide for best practices for change logs Github:
https://keepachangelog.com/en/1.0.0/

@MatteoGuarnaccia5 MatteoGuarnaccia5 changed the title added configuration for release notes generation configuration for release notes generation Aug 13, 2024
@MatteoGuarnaccia5 MatteoGuarnaccia5 requested review from joshuadkitenge and removed request for joshuadkitenge August 13, 2024 07:56
@MatteoGuarnaccia5 MatteoGuarnaccia5 changed the title configuration for release notes generation fix:configuration for release notes generation Aug 15, 2024
@MatteoGuarnaccia5 MatteoGuarnaccia5 changed the title fix:configuration for release notes generation testswet:configuration for release notes generation Aug 15, 2024
@MatteoGuarnaccia5 MatteoGuarnaccia5 changed the title testswet:configuration for release notes generation feat:configuration for release notes generation Aug 15, 2024
@MatteoGuarnaccia5 MatteoGuarnaccia5 changed the title feat:configuration for release notes generation configuration for release notes generation Aug 15, 2024
@MatteoGuarnaccia5 MatteoGuarnaccia5 changed the title configuration for release notes generation fix:configuration for release notes generation Aug 15, 2024
@MatteoGuarnaccia5 MatteoGuarnaccia5 changed the title fix:configuration for release notes generation configuration for release notes generation Aug 15, 2024
@github-actions github-actions bot added the feature New feature or request label Aug 15, 2024
@MatteoGuarnaccia5
Copy link
Contributor Author

This PR is an example for custom changelogs, which are categorized based off the the labels on pull requests. An example file has been included to show a workflow that automatically labels pull requests based off of their branch name. This change would mean making changes to the wiki, the pull request template, and optionally the readMe.

The labels used in this PR are examples, you can pick whatever labels / rules to use for future. But should be included in any documentation created.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feature New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Format the changelogs using the labels
2 participants