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

investigate release notes automation #962

Open
wants to merge 29 commits into
base: develop
Choose a base branch
from

Conversation

joshuadkitenge
Copy link
Collaborator

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

@github-actions github-actions bot added bug Something isn't working dependencies deprecated documentation Improvements or additions to documentation enhancement Improved or refactored feature feature New feature or request labels Sep 12, 2024
@github-actions github-actions bot added removed This feature has been removed security labels Sep 12, 2024
Copy link

codecov bot commented Sep 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.13%. Comparing base (d8e1be1) to head (1ab603f).

Additional details and impacted files
@@           Coverage Diff            @@
##           develop     #962   +/-   ##
========================================
  Coverage    99.13%   99.13%           
========================================
  Files           89       89           
  Lines        17572    17572           
  Branches      2130     2129    -1     
========================================
  Hits         17420    17420           
  Misses         151      151           
  Partials         1        1           

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

@joshuadkitenge joshuadkitenge force-pushed the documentation/investigate-release-notes-automation branch from be3d822 to aa9f382 Compare September 12, 2024 10:32
@joshuadkitenge joshuadkitenge force-pushed the documentation/investigate-release-notes-automation branch from aa9f382 to 066d066 Compare September 12, 2024 10:35
@joshuadkitenge joshuadkitenge removed bug Something isn't working documentation Improvements or additions to documentation enhancement Improved or refactored feature removed This feature has been removed dependencies feature New feature or request security deprecated labels Sep 12, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 12, 2024
@joshuadkitenge joshuadkitenge removed the documentation Improvements or additions to documentation label Sep 12, 2024
@github-actions github-actions bot added the documentation Improvements or additions to documentation label Sep 12, 2024
@joshuadkitenge joshuadkitenge marked this pull request as ready for review September 12, 2024 10:53
@joshuadkitenge joshuadkitenge changed the title Documentation/investigate release notes automation investigate release notes automation Sep 12, 2024
Copy link
Collaborator

@joelvdavies joelvdavies left a comment

Choose a reason for hiding this comment

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

Only looked at the branch names, had some thoughts, happy to discuss further.

security:
- head-branch: ['^security/']
documentation:
- head-branch: ['^documentation/']
Copy link
Collaborator

@joelvdavies joelvdavies Sep 16, 2024

Choose a reason for hiding this comment

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

Do these work with multiple? Could docs/documentation work for example? I personally prefer docs but then some others can't be shortened.

Same for feat/feature.

Thinking about it, perhaps its worth aligning closer with https://www.conventionalcommits.org/en/v1.0.0/ (This is what DAFNI used, although they are for commits instead)?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

enhancement:
- head-branch: ['^enhancement/']
bug:
- head-branch: ['^bug/']
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- head-branch: ['^bug/']
- head-branch: ['^fix/']

I think the branch names tend to be more to do with that they do, so this is normally fix.

feature:
- head-branch: ['^feature/']
dependencies:
- head-branch: ['^dependencies/']
Copy link
Collaborator

@joelvdavies joelvdavies Sep 16, 2024

Choose a reason for hiding this comment

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

Perhaps this and dependency if possible.

dependencies:
- head-branch: ['^dependencies/']
enhancement:
- head-branch: ['^enhancement/']
Copy link
Collaborator

Choose a reason for hiding this comment

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

Following on from these being what they do, perhaps enhance/? Or even improve/.

deprecated:
- head-branch: ['^deprecated/']
removed:
- head-branch: ['^removed/']
Copy link
Collaborator

Choose a reason for hiding this comment

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

Suggested change
- head-branch: ['^removed/']
- head-branch: ['^remove/']

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

Successfully merging this pull request may close these issues.

Format the changelogs using the labels
3 participants