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

History.txt -> History.md, add links & reformat #174

Merged
merged 2 commits into from Jan 29, 2021

Conversation

MSP-Greg
Copy link
Contributor

Change History.txt to History.md. All listed pulls/issues are now links, and the code snippets are highlighted and indented correctly. Left original text file.

I was in another repo with a similar issue, so I wrote some code to generate the links. I'll post it somewhere.

Not sure if it will render as markdown here, see:
https://github.com/MSP-Greg/rake-compiler/blob/history-txt-2-md/History.md

@MSP-Greg MSP-Greg changed the title Create History.md [skip ci] Create History.md [ci skip] Sep 11, 2020
@kou
Copy link
Member

kou commented Dec 3, 2020

Sorry for my late response.
Could you remove History.txt? We can't maintain both History.txt and History.md.

We also need to update rake-compiler.gemspec. (We may have more files to be updated.)
So please don't add [ci skip].

@Gharib110

This comment was marked as spam.

@Gharib110

This comment was marked as spam.

@MSP-Greg MSP-Greg changed the title Create History.md [ci skip] Create History.md Dec 3, 2020
@MSP-Greg
Copy link
Contributor Author

MSP-Greg commented Dec 3, 2020

@kou

I'll remove the [ci skip] and delete History.txt.

Looking at the file, the links clutter it, I can place them at the bottom of the doc? Might be a day or two.

.gemspec has s.files += Dir.glob("*.{md,rdoc,txt,yml}") , so no issue with the History files?

@kou
Copy link
Member

kou commented Dec 3, 2020

We can keep the inline links.
We'll not be able to maintain separated links when we add a new release entry.

https://github.com/rake-compiler/rake-compiler/blob/master/rake-compiler.gemspec#L43 may have a problem.

@MSP-Greg MSP-Greg changed the title Create History.md History.txt -> History.md, add links & reformat Dec 3, 2020
@olleolleolle
Copy link
Contributor

Hey, this is a ✨ sparkling improvement ✨ and I love it. I think that even if the newer releases are not "fully compliant" with links and all, that it would be easy enough to add that after-the-fact for each release. The release cadence is not that high, is it?

History.md Outdated Show resolved Hide resolved
@kou kou merged commit a2b8cd1 into rake-compiler:master Jan 29, 2021
@MSP-Greg MSP-Greg deleted the history-txt-2-md branch November 24, 2021 17:13
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.

None yet

4 participants