Skip to content
This repository has been archived by the owner on Oct 3, 2024. It is now read-only.

Lint: Check topics is not the first tag in the opam file #26

Closed
punchagan opened this issue Aug 23, 2024 · 0 comments · Fixed by #31
Closed

Lint: Check topics is not the first tag in the opam file #26

punchagan opened this issue Aug 23, 2024 · 0 comments · Fixed by #31
Assignees
@punchagan

Comments

@punchagan
Copy link
Collaborator

The dune-project file provides the following template:

 (tags
  (topics "to describe" your project))

which gets converted to the following in the opam file:

tags: ["topics" "to describe" "your" "project"]

A bunch of projects in the opam repository have the tag "topics" as their first tag, which seems incorrect.

It may be worth also changing the dune-project template to prevent users from making this error, probably by quoting all the tags? like so:

 (tags
  ("topics" "to describe" "your" "project"))
punchagan added a commit to punchagan/dune that referenced this issue Aug 27, 2024
@punchagan
Subtle hint that topics is not a keyword
71b2a19 
Number of projects in the opam-repository have the word topics as one of
the tags, presumably because of the structure of the `tags` sexp in the
dune-project file generated on `dune init`. See ocurrent/opam-ci-check#26

Signed-off-by: Puneeth Chaganti <punchagan@muse-amuse.in>
@punchagan punchagan mentioned this issue Aug 27, 2024
Merged
Leonidas-from-XIV pushed a commit to punchagan/dune that referenced this issue Aug 28, 2024
@punchagan @Leonidas-from-XIV
Subtle hint that topics is not a keyword
20e1a09 
Number of projects in the opam-repository have the word topics as one of
the tags, presumably because of the structure of the `tags` sexp in the
dune-project file generated on `dune init`. See ocurrent/opam-ci-check#26

Signed-off-by: Puneeth Chaganti <punchagan@muse-amuse.in>
punchagan added a commit to punchagan/dune that referenced this issue Aug 28, 2024
@punchagan
Subtle hint that topics is not a keyword
ef6d8b7 
Number of projects in the opam-repository have the word topics as one of
the tags, presumably because of the structure of the `tags` sexp in the
dune-project file generated on `dune init`. See ocurrent/opam-ci-check#26

Signed-off-by: Puneeth Chaganti <punchagan@muse-amuse.in>
@punchagan punchagan mentioned this issue Aug 28, 2024
Merged
@punchagan punchagan self-assigned this Aug 28, 2024
Leonidas-from-XIV pushed a commit to punchagan/dune that referenced this issue Aug 28, 2024
@punchagan @Leonidas-from-XIV
Subtle hint that topics is not a keyword
0e27cf2 
Number of projects in the opam-repository have the word topics as one of
the tags, presumably because of the structure of the `tags` sexp in the
dune-project file generated on `dune init`. See ocurrent/opam-ci-check#26

Signed-off-by: Puneeth Chaganti <punchagan@muse-amuse.in>
Leonidas-from-XIV pushed a commit to ocaml/dune that referenced this issue Aug 28, 2024
@punchagan
Subtle hint that topics is not a keyword (#10849)
25fd9f0 
Number of projects in the opam-repository have the word topics as one of
the tags, presumably because of the structure of the `tags` sexp in the
dune-project file generated on `dune init`. See ocurrent/opam-ci-check#26

Signed-off-by: Puneeth Chaganti <punchagan@muse-amuse.in>
github-merge-queue bot pushed a commit that referenced this issue Aug 30, 2024
@punchagan
Check that default, example tags have been removed
ba2e964 
Lot of repositories in the opam repository have "topics" as their first
tag, possibly due to an oversight from the maintainers. This commit adds
an explicit check to warn against leaving the default, example tags in.

Closes #26.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@punchagan punchagan

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Check that default, example tags have been removed punchagan/opam-ci-check
1 participant
@punchagan