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

Change object.file.uploaded event to file.uploaded, and document its existence #6161

Open
hackartisan opened this issue Aug 22, 2023 · 5 comments
Assignees

Comments

@hackartisan
Copy link
Contributor

Descriptive summary

The name of this event is incongruous with the other event names, see list in https://github.com/samvera/hyrax/wiki/Hyrax's-Event-Bus-(Hyrax::Publisher)

The event is not included in that list, and needs to be

Acceptance Criteria/Expected Behavior

This is a code refactor

Rationale (for feature request only)

Consistency and documentation will help core and downstream developers

Related work

the event was introduced in #5321

@hackartisan
Copy link
Contributor Author

Changing the name of this event is likely a breaking change. Wait for @dlpierce to weigh in.

@dlpierce
Copy link
Contributor

We're gearing up for a major release anyways, so my vote is to proceed.

@hackartisan
Copy link
Contributor Author

@dlpierce sounds good. Can you help specify this issue with respect to how and where the breaking change should be documented?

@dlpierce
Copy link
Contributor

Let's make sure it is noted in the release notes and added to the newly minted upgrade guide

@hackartisan
Copy link
Contributor Author

👍🏻 This will be release notes for a 5.0? Is there are draft for that somewhere?

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

No branches or pull requests

3 participants