GitHub changelog links to commits











up vote
0
down vote

favorite












Some projects have a CHANGELOG.md file where each version links to the range of commits that were made for that version. For example, this one. It looks like these links are automatically generated somehow, because the markdown only contains [1.0.0] where the rendered document has a link to https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0.



How does that work? I've tried to do something like this on my own project, but the rendered document just said [1.0.0]; no link was generated.



Presumably it has something to do with the tags, which follow a similar pattern (v1.0.0), but when I tried to create similar tags in my project, it still didn't work.



I also could find no reference to this on the GitHub help, or anywhere else for that matter.



Is this indeed an (undocumented?) feature of GitHub? If yes, how does it work? If no, how do these projects do it?



Note, I'm not interested in automatically generating a changelog from commits like this project does. I'm just interested in the mechanics of these hyperlinks.










share|improve this question


























    up vote
    0
    down vote

    favorite












    Some projects have a CHANGELOG.md file where each version links to the range of commits that were made for that version. For example, this one. It looks like these links are automatically generated somehow, because the markdown only contains [1.0.0] where the rendered document has a link to https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0.



    How does that work? I've tried to do something like this on my own project, but the rendered document just said [1.0.0]; no link was generated.



    Presumably it has something to do with the tags, which follow a similar pattern (v1.0.0), but when I tried to create similar tags in my project, it still didn't work.



    I also could find no reference to this on the GitHub help, or anywhere else for that matter.



    Is this indeed an (undocumented?) feature of GitHub? If yes, how does it work? If no, how do these projects do it?



    Note, I'm not interested in automatically generating a changelog from commits like this project does. I'm just interested in the mechanics of these hyperlinks.










    share|improve this question
























      up vote
      0
      down vote

      favorite









      up vote
      0
      down vote

      favorite











      Some projects have a CHANGELOG.md file where each version links to the range of commits that were made for that version. For example, this one. It looks like these links are automatically generated somehow, because the markdown only contains [1.0.0] where the rendered document has a link to https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0.



      How does that work? I've tried to do something like this on my own project, but the rendered document just said [1.0.0]; no link was generated.



      Presumably it has something to do with the tags, which follow a similar pattern (v1.0.0), but when I tried to create similar tags in my project, it still didn't work.



      I also could find no reference to this on the GitHub help, or anywhere else for that matter.



      Is this indeed an (undocumented?) feature of GitHub? If yes, how does it work? If no, how do these projects do it?



      Note, I'm not interested in automatically generating a changelog from commits like this project does. I'm just interested in the mechanics of these hyperlinks.










      share|improve this question













      Some projects have a CHANGELOG.md file where each version links to the range of commits that were made for that version. For example, this one. It looks like these links are automatically generated somehow, because the markdown only contains [1.0.0] where the rendered document has a link to https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0.



      How does that work? I've tried to do something like this on my own project, but the rendered document just said [1.0.0]; no link was generated.



      Presumably it has something to do with the tags, which follow a similar pattern (v1.0.0), but when I tried to create similar tags in my project, it still didn't work.



      I also could find no reference to this on the GitHub help, or anywhere else for that matter.



      Is this indeed an (undocumented?) feature of GitHub? If yes, how does it work? If no, how do these projects do it?



      Note, I'm not interested in automatically generating a changelog from commits like this project does. I'm just interested in the mechanics of these hyperlinks.







      github auto-generate changelog






      share|improve this question













      share|improve this question











      share|improve this question




      share|improve this question










      asked Nov 11 at 18:13









      jqno

      11k64666




      11k64666
























          1 Answer
          1






          active

          oldest

          votes

















          up vote
          1
          down vote



          accepted










          You need to look beneath the surface of the Markdown, it's a simple trick he done by using the file compare feature to compare tags.



          If you look at the RAW file, you should notice at the bottom he added links to each version number that has a compare link assigned to it.



          ## [1.0.0] - 2017-06-20

          [1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0


          With pretty mode, you would see the link to the compare page.






          share|improve this answer





















            Your Answer






            StackExchange.ifUsing("editor", function () {
            StackExchange.using("externalEditor", function () {
            StackExchange.using("snippets", function () {
            StackExchange.snippets.init();
            });
            });
            }, "code-snippets");

            StackExchange.ready(function() {
            var channelOptions = {
            tags: "".split(" "),
            id: "1"
            };
            initTagRenderer("".split(" "), "".split(" "), channelOptions);

            StackExchange.using("externalEditor", function() {
            // Have to fire editor after snippets, if snippets enabled
            if (StackExchange.settings.snippets.snippetsEnabled) {
            StackExchange.using("snippets", function() {
            createEditor();
            });
            }
            else {
            createEditor();
            }
            });

            function createEditor() {
            StackExchange.prepareEditor({
            heartbeatType: 'answer',
            convertImagesToLinks: true,
            noModals: true,
            showLowRepImageUploadWarning: true,
            reputationToPostImages: 10,
            bindNavPrevention: true,
            postfix: "",
            imageUploader: {
            brandingHtml: "Powered by u003ca class="icon-imgur-white" href="https://imgur.com/"u003eu003c/au003e",
            contentPolicyHtml: "User contributions licensed under u003ca href="https://creativecommons.org/licenses/by-sa/3.0/"u003ecc by-sa 3.0 with attribution requiredu003c/au003e u003ca href="https://stackoverflow.com/legal/content-policy"u003e(content policy)u003c/au003e",
            allowUrls: true
            },
            onDemand: true,
            discardSelector: ".discard-answer"
            ,immediatelyShowMarkdownHelp:true
            });


            }
            });














            draft saved

            draft discarded


















            StackExchange.ready(
            function () {
            StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53251732%2fgithub-changelog-links-to-commits%23new-answer', 'question_page');
            }
            );

            Post as a guest















            Required, but never shown

























            1 Answer
            1






            active

            oldest

            votes








            1 Answer
            1






            active

            oldest

            votes









            active

            oldest

            votes






            active

            oldest

            votes








            up vote
            1
            down vote



            accepted










            You need to look beneath the surface of the Markdown, it's a simple trick he done by using the file compare feature to compare tags.



            If you look at the RAW file, you should notice at the bottom he added links to each version number that has a compare link assigned to it.



            ## [1.0.0] - 2017-06-20

            [1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0


            With pretty mode, you would see the link to the compare page.






            share|improve this answer

























              up vote
              1
              down vote



              accepted










              You need to look beneath the surface of the Markdown, it's a simple trick he done by using the file compare feature to compare tags.



              If you look at the RAW file, you should notice at the bottom he added links to each version number that has a compare link assigned to it.



              ## [1.0.0] - 2017-06-20

              [1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0


              With pretty mode, you would see the link to the compare page.






              share|improve this answer























                up vote
                1
                down vote



                accepted







                up vote
                1
                down vote



                accepted






                You need to look beneath the surface of the Markdown, it's a simple trick he done by using the file compare feature to compare tags.



                If you look at the RAW file, you should notice at the bottom he added links to each version number that has a compare link assigned to it.



                ## [1.0.0] - 2017-06-20

                [1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0


                With pretty mode, you would see the link to the compare page.






                share|improve this answer












                You need to look beneath the surface of the Markdown, it's a simple trick he done by using the file compare feature to compare tags.



                If you look at the RAW file, you should notice at the bottom he added links to each version number that has a compare link assigned to it.



                ## [1.0.0] - 2017-06-20

                [1.0.0]: https://github.com/olivierlacan/keep-a-changelog/compare/v0.3.0...v1.0.0


                With pretty mode, you would see the link to the compare page.







                share|improve this answer












                share|improve this answer



                share|improve this answer










                answered Nov 11 at 19:45









                Praveen P

                1,2541717




                1,2541717






























                    draft saved

                    draft discarded




















































                    Thanks for contributing an answer to Stack Overflow!


                    • Please be sure to answer the question. Provide details and share your research!

                    But avoid



                    • Asking for help, clarification, or responding to other answers.

                    • Making statements based on opinion; back them up with references or personal experience.


                    To learn more, see our tips on writing great answers.





                    Some of your past answers have not been well-received, and you're in danger of being blocked from answering.


                    Please pay close attention to the following guidance:


                    • Please be sure to answer the question. Provide details and share your research!

                    But avoid



                    • Asking for help, clarification, or responding to other answers.

                    • Making statements based on opinion; back them up with references or personal experience.


                    To learn more, see our tips on writing great answers.




                    draft saved


                    draft discarded














                    StackExchange.ready(
                    function () {
                    StackExchange.openid.initPostLogin('.new-post-login', 'https%3a%2f%2fstackoverflow.com%2fquestions%2f53251732%2fgithub-changelog-links-to-commits%23new-answer', 'question_page');
                    }
                    );

                    Post as a guest















                    Required, but never shown





















































                    Required, but never shown














                    Required, but never shown












                    Required, but never shown







                    Required, but never shown

































                    Required, but never shown














                    Required, but never shown












                    Required, but never shown







                    Required, but never shown







                    Popular posts from this blog

                    Florida Star v. B. J. F.

                    Danny Elfman

                    Retrieve a Users Dashboard in Tumblr with R and TumblR. Oauth Issues