Document the requirement to push releases #2109
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Currently there isn't any documentation about the requirement to push releases/tags to the `source_url` to get links to specific versions of the code. So this PR adds this documentation. I couldn't find a general spot where `source_url` is talked about so I added an admonition near where it is first introduced.
|
📦 Docs artifacts are ready: https://github.com/elixir-lang/ex_doc/actions/runs/14295170776/artifacts/2890549314 |
josevalim
reviewed
Apr 6, 2025
Co-authored-by: José Valim <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Currently there isn't any documentation about the requirement to push releases/tags to the
source_urlto get links to specific versions of the code. So this PR adds this documentation.I couldn't find a general spot where
source_urlis talked about so I added an admonition near where it is first introduced.Background: recently (in PostHog/posthog-elixir#14 (comment)) I was asked where the requirement for pushing git tags comes from. I wasn't able to find any official documentation (here or in https://hexdocs.pm/elixir/writing-documentation.html) so I have created this PR.
Here's what it looks like when I build the documentation locally:
