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

Updated Changelog, updated Welcome Package ChangeLog #325

Merged
merged 4 commits into from
Jan 15, 2023

Conversation

confused-Techie
Copy link
Member

This PR updates our changelog with any missing entries.

This PR adds few entries to our top level changelog, and focuses mostly on adding the missing items in our detailed description below.

Additionally this PR adds those major changes to the welcome package ChangeLog View.


In this PR you'll notice I've slightly changed the styling. This is because the group styling we had the last time didn't render well when not viewed as Markdown source, and looked somewhat ugly when actually viewable on our Website, or GitHub release.

So with this I've opted to add those bundled sections as just individual change definitions at the start of the line.

Additionally you'll notice I didn't go through the trouble of adding in the uniform spacing between each item. We can add this if we would like, but because of it, and it's inconsistency when placed onto GitHub Release Notes our Website, and Reddit, they had to manually remade on each platform, causing a bit of a headache.

Lastly I also opted to remove the links from the ChangeLog View within the welcome package. Really the first time around it become difficult to track down the exact PR of each change, and in some cases a change couldn't be linked to a single PR but really to several and made us have to choose which one essentially gets the credit here.

So instead I've opted to just add the text, and we have a top level link to our actual ChangeLog if anyone would like to further review the exact commits that allowed those changes to be possible.


If this all looks good, awesome lets merge, and get ready for another release!

Copy link
Member

@kaosine kaosine left a comment

Choose a reason for hiding this comment

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

Seems good to me, and even looking at this is all the more reason to push out a beta asap. Esp if it fixes this stuff. I would like to figure out my rpm updating issue when installing a new release(that is obviously tagged properly as is) but eh I think that is less pressing than the issues this release would fix.

CHANGELOG.md Outdated Show resolved Hide resolved
CHANGELOG.md Outdated
### ppm
- Added: Convert body params to query params [@Spiker985](https://github.com/pulsar-edit/ppm/pull/47)
- Fixed: src: Update Electron header download URL [@DeeDeeG](https://github.com/pulsar-edit/ppm/pull/43)

## v1.100.1-beta
Copy link
Member

Choose a reason for hiding this comment

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

I think this was meant to be ## v1.100.0-beta and the new one will be either v1.101.0 or v1.100.1?

Copy link
Member Author

Choose a reason for hiding this comment

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

Our last beta was under v1.100.1-beta, so our next, since there are no API changes on Pulsars end should likely be v1.100.2-beta.

The tag you see there is for all release notes that are beneath that section. The ChangeLog for these changes all fall under the [Unreleased] Section

Copy link
Member

Choose a reason for hiding this comment

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

No, it is both, I remember now. The tag is 1.100.1 but the app version is actually 1.100.0, basically we have a mismatch between the two.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah sounds like we got it sorted out on Discord mainly.

Do you think we should modify whats here or leave it as is?

Copy link
Member

Choose a reason for hiding this comment

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

Personally I think the changelog should be edited to reflect the actual binary version that is out there in the wild.

Co-authored-by: Daeraxa <[email protected]>
@confused-Techie confused-Techie mentioned this pull request Jan 10, 2023
3 tasks
@confused-Techie
Copy link
Member Author

Alright with approval, going to go ahead and merge this one.

I've tagged the [Unreleased] version to be our 1.101.0-beta so we are ready to publish

@confused-Techie confused-Techie merged commit c855ff2 into master Jan 15, 2023
@Spiker985 Spiker985 deleted the keep-a-changelog branch February 24, 2023 07:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants