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.

Sign up for GitHub

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

Jump to bottom

GitHub release changelog number misinterpreted as issue reference #16455

Open
Marcono1234 opened this issue Jan 30, 2024 · 7 comments · May be fixed by #17165
Open

GitHub release changelog number misinterpreted as issue reference #16455

Marcono1234 opened this issue Jan 30, 2024 · 7 comments · May be fixed by #17165
Labels
A-infra CI and workflow issues C-bug Category: bug

Comments

@Marcono1234
Copy link

The description of the GitHub releases under https://github.com/rust-lang/rust-analyzer/releases uses the format

= Changelog #{changelog_n}

...

The problem is that GitHub misinterprets this #<number> as issue / PR reference, which is quite confusing:
Changelog screenshot

It seems escaping the # with a \ has no effect (at least not in the preview), so maybe it would be best to simply omit the # (or add a zero-width space or similar between)?
@Marcono1234 Marcono1234 added the C-bug Category: bug label Jan 30, 2024
@lnicola lnicola added the A-infra CI and workflow issues label Jan 31, 2024
@Young-Flash
Copy link
Member

how about No.218?

@lnicola
Copy link
Member

lnicola commented Jan 31, 2024

How about we strip it off? It makes sense to have it on https://rust-analyzer.github.io/thisweek/2024/01/29/changelog-218.html, but not on the GitHub Releases page.

@Young-Flash
Copy link
Member

Is the related setting here?

rust-analyzer/xtask/src/release/changelog.rs

Lines 82 to 84 in e4146af

let contents = format!(
"\
= Changelog #{changelog_n}

@lnicola
Copy link
Member

lnicola commented Jan 31, 2024 •
edited

No, it's around

rust-analyzer/xtask/src/publish.rs

Lines 10 to 11 in e4146af

let asciidoc = sh.read_file(&self.changelog)?;
let mut markdown = notes::convert_asciidoc_to_markdown(std::io::Cursor::new(&asciidoc))?;
.

The code you linked to generates a changelog ASCIIDoc on disk, which is then edited and published to the website. Then that gets read, converted to Markdown, and is used to update the release on GitHub. We can probably strip off the Changelog #XXX line after reading the file.

@Marcono1234
Copy link
Author

Marcono1234 commented Mar 5, 2024 •
edited

Has a decision been made yet how this should be solved?
Would it be fine to just perform a regex ^Changelog # to Changelog replacement? (though the xtask project here seems to have no regex dependency yet)

@lnicola
Copy link
Member

lnicola commented Mar 5, 2024

We should strip off that line (we probably don't need regex though).

@Marcono1234 Marcono1234 linked a pull request Apr 30, 2024 that will close this issue
Draft
@Marcono1234
Copy link
Author

@lnicola, I have tried to implement this now in #17165.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
A-infra CI and workflow issues C-bug Category: bug
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Omit changelog header from GitHub release notes Marcono1234/rust-analyzer
3 participants
@lnicola @Marcono1234 @Young-Flash