Skip to content

[Dev] Update DocumenterReference #386

Closed

Description

@ocots
No description provided.

Activity

  1. self-assigned this
    on Dec 8, 2025
  2. added
    devInternal change, no user-facing impact
    on Dec 8, 2025
  3. linked a pull request that will close this issueImprove DocumenterReference #387on Dec 8, 2025
  4. ocots commented on Dec 8, 2025

    @ocots
    MemberAuthor
  5. JuliaRegistrator commented on Dec 8, 2025

    @JuliaRegistrator

    Registration pull request created: JuliaRegistries/General/143905

    Recommendation: add release notes

    Release notes help your users know what has changed in the new version. For breaking releases in particular, it's recommended to document what breaking changes were made (or point to where changes can be found, such as a changelog).

    To add release notes, just add markdown formatted text underneath the comment after the text "Release notes:" and it will be added to the registry PR, and if TagBot is installed it will also be added to the release that TagBot creates. i.e.

    @JuliaRegistrator register
    
    Release notes:
    
    ## Breaking changes
    
    - blah
    

    To add release notes to this registration, just re-invoke JuliaRegistrator and the PR will be updated.

    Tagging

    After the above pull request is merged, it is recommended that a tag is created on this repository for the registered package version.

    This will be done automatically if the Julia TagBot GitHub Action is installed, or can be done manually through the github interface, or via:

    git tag -a v0.17.1 -m "<description of version>" 0134b90d9d6b22d9c8fc0477879bb9c4c7a1def1
    git push origin v0.17.1
    
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

Labels

devInternal change, no user-facing impact

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions