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
Open
Show file tree
Hide file tree
Changes from 28 commits
Commits
Show all changes
29 commits
Select commit Hold shift + click to select a range
32feeb7
added configuration for release notes generation
MatteoGuarnaccia5 Aug 12, 2024
c1ddf5d
moved changelog code to release.yml at .github level
MatteoGuarnaccia5 Aug 12, 2024
fa38bad
added dependencies section to changelog
MatteoGuarnaccia5 Aug 12, 2024
8a928ed
refatored changelog to follow keepchangelog structure
MatteoGuarnaccia5 Aug 13, 2024
eabbf1e
include empty categories
MatteoGuarnaccia5 Aug 13, 2024
4d28c00
empty categories showing did not work
MatteoGuarnaccia5 Aug 13, 2024
837d58d
changed pr template
MatteoGuarnaccia5 Aug 13, 2024
957a9db
added pr guidelines to readme
MatteoGuarnaccia5 Aug 14, 2024
762eac8
reordered categories in changelog, and removed invalid label as a label
MatteoGuarnaccia5 Aug 14, 2024
cae0c18
test check enforcement of pr titles
MatteoGuarnaccia5 Aug 15, 2024
2538569
fixed workflow
MatteoGuarnaccia5 Aug 15, 2024
5d43e97
changed regex conditional
MatteoGuarnaccia5 Aug 15, 2024
e565801
changed to use package
MatteoGuarnaccia5 Aug 15, 2024
a8dfeca
fixed syntax in .yml file
MatteoGuarnaccia5 Aug 15, 2024
282792c
removed help message
MatteoGuarnaccia5 Aug 15, 2024
2ac5683
removed dash from uses
MatteoGuarnaccia5 Aug 15, 2024
214ec87
changed regular expression action uses
MatteoGuarnaccia5 Aug 15, 2024
eace6a5
renamed some change log categories
MatteoGuarnaccia5 Aug 15, 2024
8875d0b
added help message back in
MatteoGuarnaccia5 Aug 15, 2024
7d0ca77
moved pr title check to seperate file
MatteoGuarnaccia5 Aug 15, 2024
f1db2e5
test using labeler
MatteoGuarnaccia5 Aug 15, 2024
adc1232
changed labeler rule
MatteoGuarnaccia5 Aug 15, 2024
2957e12
Merge pull request #889 from ral-facilities/feature/test-feature
MatteoGuarnaccia5 Aug 15, 2024
7b2c4d4
Add more labels to the labeler #806
joshuadkitenge Sep 12, 2024
066d066
fix bug #806
joshuadkitenge Sep 12, 2024
4ff6aad
move back to ci-build.yml
joshuadkitenge Sep 12, 2024
3379d1a
checkout actions first
joshuadkitenge Sep 12, 2024
91d95ea
Add issue template #806
joshuadkitenge Sep 12, 2024
1ab603f
Merge branch 'develop' into documentation/investigate-release-notes-a…
joshuadkitenge Jan 8, 2025
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Add a set up instructions describing how the reviewer should test the code
- [ ] Review code
- [ ] Check Actions build
- [ ] Review changes to test coverage
- [ ] Ensure the pull request has been labeled appropriately
- [ ] {more steps here}

## Agile board tracking
Expand Down
16 changes: 16 additions & 0 deletions .github/labeler.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
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.

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/.

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.

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/']

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.

27 changes: 27 additions & 0 deletions .github/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
changelog:
exclude:
labels:
- documentation
- dependencies
categories:
- title: New Features
labels:
- feature
- title: Changed
labels:
- enhancement
- title: Fixed
labels:
- bug
- title: Deprecated
labels:
- deprecated
- title: Removed
labels:
- removed
- title: Security
labels:
- security
- title: Other Changes
labels:
- '*'
36 changes: 36 additions & 0 deletions .github/workflows/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
## Description

Provide a clear and concise description of the issue or feature request.

## Acceptance Criteria

- [ ] List all criteria that must be met for this issue to be considered complete.
- [ ] Each item should be actionable and testable.

## Steps to Reproduce (For bugs)

If this is a bug, provide the steps to reproduce the issue:

1. Step one
2. Step two
3. Step three

## Expected Behavior

What should happen once the issue is resolved?

## Actual Behavior (For bugs)

What is happening instead of the expected behavior?

## Screenshots or Logs (Optional)

Include any relevant screenshots or logs that help explain the issue.

## Additional Context

Any other information that may help resolve the issue, such as environment details, code references, etc.

## Labeling

Ensure this issue has been labeled appropriately (e.g., bug, feature, enhancement, documentation).
13 changes: 13 additions & 0 deletions .github/workflows/ci-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,19 @@ on:
- develop

jobs:
labeler:
permissions:
contents: read
pull-requests: write
runs-on: ubuntu-latest
steps:
- name: Checkout repo
uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4

- uses: actions/labeler@v5
with:
repo-token: ${{ secrets.GITHUB_TOKEN }}

lint-and-unit-test:
name: Lint & Unit Tests
runs-on: ubuntu-latest
Expand Down
8 changes: 8 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -131,3 +131,11 @@ This guide outlines the steps to perform end-to-end testing for the Inventory Ma
By following these instructions, you can effectively conduct end-to-end testing for the Inventory Management System. Choose the method that best suits your testing requirements and development environment.

**Note:** On the CI environment, the IMS-API is accessed via `127.0.0.1` due to issues with `localhost`.

## Pull Request Guidelines

- Follow the `PULL_REQUEST_TEMPLATE` when drafting a pull request

- Ensure the pull request is labeled appropriately

- Ensure pull request name is descriptive of issue it is related to