Stateless Code | Create a RubyGem 90: Fix README to Use Relative Links Instead of Absolute Links @StatelessCode | Uploaded February 2023 | Updated October 2024, 3 hours ago.
In one of our videos in the NerdDice.com series, we fixed our CONTRIBUTING.md file to use relative links instead of absolute links and added this item to the NerdDice backlog because there was a similar issue here.
In most cases (with the exception we note below about the CHANGELOG), you want to use relative links in your repository's GitHub Markdown files. That way when you are on a branch working on something, the links will resolve to the file on that branch instead of always pointing back to the master branch.
In our case, there's only one bad link to be fixed. When our build runs on the push, it succeeds, but the benchmark fails on the pull request. Since none of the code related to that benchmark script or any application code changed, we demonstrate how to re-run the failed build to get it passing.
This video covers:
00:00:12 Introduction
00:01:50 Review a similar example commit in the NerdDice.com application with relative links
00:02:18 Demonstrate absolute link to be corrected
00:02:47 Explain reasoning for keeping changelog_uri in gemspec an absolute link to master and plans for CHANGELOG on legacy branches.
00:03:40 Check out a new branch and demonstrate use of GitHub markdown editor and preview
00:05:08 Make the edit to use a relative link
00:05:49 Commit and push the change
00:06:52 Open pull request
00:07:27 Benchmark build fails on pull request, but not push. Re-run failed build and it passes.
00:08:20 Merge and close issue
#ruby #rubygems #codecast #screencast #NerdDice #DnD #roleplaying #softwaredevelopment #github #opensource #dice #TDD #maintain #githubactions #markdown #readme
See other related StatelessCode videos:
- Flesh Out the README for the Project youtu.be/EQioYZAWvGU
This video is CC0 - No rights reserved. (YouTube doesn't allow this option when publishing.) All code is released under the UNLICENSE. Stateless Code denies the concept of "intellectual property". Copying is not stealing.
In one of our videos in the NerdDice.com series, we fixed our CONTRIBUTING.md file to use relative links instead of absolute links and added this item to the NerdDice backlog because there was a similar issue here.
In most cases (with the exception we note below about the CHANGELOG), you want to use relative links in your repository's GitHub Markdown files. That way when you are on a branch working on something, the links will resolve to the file on that branch instead of always pointing back to the master branch.
In our case, there's only one bad link to be fixed. When our build runs on the push, it succeeds, but the benchmark fails on the pull request. Since none of the code related to that benchmark script or any application code changed, we demonstrate how to re-run the failed build to get it passing.
This video covers:
00:00:12 Introduction
00:01:50 Review a similar example commit in the NerdDice.com application with relative links
00:02:18 Demonstrate absolute link to be corrected
00:02:47 Explain reasoning for keeping changelog_uri in gemspec an absolute link to master and plans for CHANGELOG on legacy branches.
00:03:40 Check out a new branch and demonstrate use of GitHub markdown editor and preview
00:05:08 Make the edit to use a relative link
00:05:49 Commit and push the change
00:06:52 Open pull request
00:07:27 Benchmark build fails on pull request, but not push. Re-run failed build and it passes.
00:08:20 Merge and close issue
#ruby #rubygems #codecast #screencast #NerdDice #DnD #roleplaying #softwaredevelopment #github #opensource #dice #TDD #maintain #githubactions #markdown #readme
See other related StatelessCode videos:
- Flesh Out the README for the Project youtu.be/EQioYZAWvGU
This video is CC0 - No rights reserved. (YouTube doesn't allow this option when publishing.) All code is released under the UNLICENSE. Stateless Code denies the concept of "intellectual property". Copying is not stealing.
