release-notes/release-notes-hub

Hosted release notes for open source projects.

release-notes-hub's Issues

Broadcast release-notes updates

As a release-notes subscriber i would like to receive updates via email.

Acceptance Criteria

• Receive an email for an active subscription after a release-note was updated

---

Depends on #5
Depends on #4

Add support for managing private auth tokens

Acceptance Criteria

• Manage auth tokens under /auth-tokens
• Create a new auth token
• Delete existing auth token

Publish via API

• Introduce an API interface
• Implement authorization via auth tokens
• Implement POST /publish endpoint

Deep Github intergration - Changelog

As a software maintainer I want to connect my github repositories to release-notes, so that all updates to my changelog or release-notes definition get automatically published to the hub.

Acceptance Criteria:

• Connect existing release notes with github repo
• Create new release notes from github repo
• Select branch to check for updates, (default master)
• Read notes from release-notes.yml file, fallback to CHANGELOG.md

Signin with github

As a release-notes publisher i would like to be able to authenticate with my existing github account.

Acceptamce Criteria

• A new account can be created with github oauth
• I can login to an existing account using github oauth

Signin with google

As a release-notes publisher i would like to be able to authenticate with my existing google account.

Acceptamce Criteria

• A new account can be created with google oauth
• I can login to an existing account using google oauth

Improve redirect after login

As a user i want to be redirected to the auth-guarded page i was requesting before i had to login.

Acceptance Criteria

• As an unauthorized user try to access /publish and see signin form
• After successfull signin see publish page.
• The same is working for signup
• The redirect also works when switching between signup and signin views

Verify email

As the system operator i need to make sure, that users verify their email address before can publish release notes and before they can receive notifications.

Acceptance Criteria:

• A verification email is send upon account registration (with email & password)
• Following the link from the verification email verifies the user.
• An unverified user is not able to publish release-notes
• An unverified user is able* to subscribe for updates
• Only verified users receive update notifications

Add support for subscribing to release note updates

Acceptance Criteria

• Display "Subscribe" button on release-notes detail page
• Require the user to be logged in, before being able to subscribe
• See and manage active subscriptions at https://release-notes.com/subscriptions
• Allow for unsubscribing from release notes

Delete "release note" ( or project )

I'd wanna delete my mistake spelled.
(especially, https://release-notes.com/release-notes/@jc01rho/tewt)

so delete feature is needed. :)

Setup page tracking with piwik

Acceptance Criteria

• A dedicated piwik instance at https://piwik.release-notes.com is up and running
• The layout is adjusted to track every page view

Input validation

Acceptance Criteria

• The only valid characters for usernames are [a-zA-Z0-9\-]
• The only valid characters for release-notes names are [a-zA-Z0-9\-]
• E-mail addresses need to be formally valid
• Invalid input displays an error next to the input field

Allow for sending update notifications to slack

As a release notes subscriber, i would like to receive update notification via slack.

Badges for release notes

As a maintainer of an open source project i want to integrate a badge that links to the hosted release notes in the project's README file.

Acceptance Criteria:

• Add badge image in svg format
• Add ability to copy the badge markdown from release notes edit view.

Deep Github intergration - Releases

As a software maintainer I want to create and sync a release-notes page with github releases.

Relates to #40

ToDo:

• Research if github provides webhooks for release update events

Acceptance Criteria:

• There is a new option to sync a release-notes page with "github releases"

Nice to Have:

• Create release-notes.yml or CHANGELOG.md from github releases

Require username only when necessary

As a release notes subsriber i do not want to define a username that is only required for publishing release notes.

Acceptance Criteria

• Create a new account and only email/password is required
• Upon publishing release notes setting a username is mandatory

Incorrect dates are shown on release pages

@IjzerenHein reported:

The dates in the CHANGELOG.md file do not correspond the ones on the hub. They seem to be one day off, probably due to a timezone conversion.
https://github.com/IjzerenHein/firestorter/blob/master/CHANGELOG.md

• Use UTC all over the place

Allow for updating release-notes

As a release-notes publisher i would like to update my previously uploaded release notes.

Acceptance Criteria

• A list of all owned release notes is displayed at https://release-notes.com/release-notes
• An upload button next to each release-note in the list allows for updating a release note
• It is not possible to update some one elses release-notes
• Release notes updates show up on the public release notes page right away

Add license page

As the project maintainer i want to make the licesing as transparent as possible. Therefore i want to make the source code licenses of the release-notes project accessible from the hub.

Acceptance Criteria

• The release notes MIT license can be accessed from https://release-notes.com/mit-license

CHANGELOG.md support

Allow for publishing changelog.md files.

• Allow for publishing .md files via API
• Allow for publishing .md files via web frontend

Update `mdi-svg` dependency to `@mdi/svg`

Currently it looks like this project is using v2.1.19. When you update to the latest version. Please ensure to switch the dependency for mdi-svg to the @mdi/svg package. Which is on v2.2.43.

Thanks!

We'll be deprecating mdi-svg shortly.

Release description is not displayed in notification email

Password reset / recover

As a user i want to be able to reset or recover my password.

Acceptance Criteria

• Signin contains a link to "recover password"
• The recover password page takes the users email
• A recovery token is send to the email if the account exists
• Following the recover link in the email allows you to reset the password.