Skip to content

path option in repository can mess with git tags #3858

Open
@ghivert

Description

@ghivert

When adding a path in repository in gleam.toml, when there's multiple packages in the repo, their versions can go out of sync.

Let's take an example:

  • There's a package foo, located in repo/foo, in version 1.0.0.
  • There's a package bar, located in repo/bar in version 1.1.0.
  • When you generate documentation, all generated paths expect to find a tag in the git repo, and the path refers the tag.
    For foo, it will be https://.../v1.0.0/foo/src/module.gleam. For bar, it will be https://.../v1.1.0/bar/src/module.gleam.
  • Tags in your git repo can be not synchronized, because sometimes you just cannot properly tag the repo for every version of every packages.

A solution would be to use the same version number for every packages. Every time a package version bumps, bump the other packages to the same version, and republish everything. That way, all tags will always be true.
However, it's more work for the maintainer.

One solution could be to point to a commit in the repo, instead of a tag.


The problem can be seen in the Sketch documentation at the moment of writing. Sketch is working, while sketch_lustre is not working.

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions