Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Go suggestions for PURL-TYPES.rst #196

Open
wants to merge 6 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions PURL-TYPES.rst
Original file line number Diff line number Diff line change
Expand Up @@ -259,14 +259,13 @@ golang
- There is no default package repository: this is implied in the namespace
using the ``go get`` command conventions.
- The ``namespace`` and `name` must be lowercased.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

where did this definition of namespace/name go?
see #308

Copy link
Author

@tiegz tiegz Oct 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@jkowalleck your Issue adds more nuance to this problem, so I left a link in there to an argument against namespaces for Go : #63 (comment)

to expedite this PR, I'll just revert that removal for now.

- The ``subpath`` is used to point to a subpath inside a package.
- The ``version`` is often empty when a commit is not specified and should be
the commit in most cases when available.
- The ``subpath`` is used to point to a package inside a module.
- The ``version`` may start with a lowercased "v" followed by: a semantic version, or a Go "pseudo-version", which consists of a semantic version followed by a timestamp and revision identifier.
- Examples::

pkg:golang/github.com/gorilla/context@234fd47e07d1004f0aed9c
pkg:golang/github.com/gorilla/context@v1.1.1
pkg:golang/google.golang.org/genproto#googleapis/api/annotations
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

☝️ This still leaves an empty version example without while removing the mention from the version description

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

mentioned this above, but PURL-SPECIFICATION indicates that versions can be empty

pkg:golang/github.com/gorilla/context@234fd47e07d1004f0aed9c#api
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please keep one of the github sha-1 hash examples in

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At least for modern Go tools, it should be a pseudo-version, not a bare commit ID like it is now: https://go.dev/doc/modules/version-numbers#in-development

pkg:golang/golang.org/x/[email protected]#collate

hackage
-------
Expand Down