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

Strip markdown from release notes #1758

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mplorentz
Copy link
Member

I found myself not reading the release notes when I open Nos because they aren't formatted nicely with all the markdown links. I'm not sure if this will totally solve my issue of having glanceable release notes, but it feels like a step in the right direction. Let me know what you think.

How to test

  1. Run a fastlane build or check out Nos Dev 1.1.1 (10) which was built with this branch.
  2. Check the release notes in App Store Connect or after downloading the app. The Github issue links should be removed.

Screenshots/Video

Before After
Screenshot 2025-02-06 at 6 27 19 AM Screenshot 2025-02-06 at 6 27 12 AM

changelog: changelog,
app_identifier: options[:app_identifier],
changelog: cleaned_changelog,
app_identifier: options[:appidentifier],
Copy link
Member Author

Choose a reason for hiding this comment

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

The AI found this bug with appidentifer, and it looks right to me but I'm not sure why it wasn't causing an error before 🤷

Copy link
Contributor

Choose a reason for hiding this comment

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

Nice catch, AI 🤖 👏

@pelumy
Copy link
Contributor

pelumy commented Feb 6, 2025

Do we just want to stop adding the link to the issue in the changelog? Or we want contributors to be able to see the link in the changelog?

@pelumy
Copy link
Contributor

pelumy commented Feb 6, 2025

I didn't need to run a fastlane build. I don't think I know how to do that. Is there a notion doc for this?

I have the last dev build and can see the changes so it works 🎉 . It was strange seeing those builds yesterday, but now I understand why 😄.

@joshuatbrown
Copy link
Contributor

The release notes certainly look much nicer this way. As a person who does UAT and QA, I want to see the issue numbers, at least. The URLs were originally necessary because we switched our issues from the Nos repo to the Verse Issues one.

I'm not saying the issue numbers need to be in the TestFlight notes. I do need them somewhere, though, so it's 100% clear what issues are solved in a given release. I wonder if GitHub Releases might be a different solution. I just don't have a full grasp on the process yet, so I'm not sure what solution would be best.

@joshuatbrown
Copy link
Contributor

Oh! Just realized that maybe the Milestones feature in GitHub is a different way to solve this. If GitHub could tell me "here are the tickets to UAT in the latest staging build", that might work and I might not need the TestFlight release notes at all. I suppose the entire UAT column already tells me that, so maybe the question is really "what tickets in the QA column are in the latest QA/release build?"

@pelumy
Copy link
Contributor

pelumy commented Feb 6, 2025

No point stressing about this since @mplorentz already created a fix for this by stripping the URLs 😄. I will be approving and merging. Thanks for your thoughts @joshuatbrown.

Copy link
Contributor

@pelumy pelumy left a comment

Choose a reason for hiding this comment

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

Thanks for fixing this Matt!

@mplorentz mplorentz changed the title refactor Strip markdown from release notes Feb 6, 2025
Copy link
Contributor

@joshuatbrown joshuatbrown left a comment

Choose a reason for hiding this comment

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

Marking with request changes so we can sort out the concerns I have about getting specific ticket numbers or links.

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