open-policy-agent / open-policy-agent/frameworks

Consider tagging submodule "constraint"?

Open
#294 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
127
Forks
61
Avg merge
1d 17h
Merged PRs (30d)
13

Description

I found that packages, say github.com/open-policy-agent/frameworks/constraint/pkg/client, are placed in submodule github.com/open-policy-agent/frameworks/constraint instead of root module.

However, it seems that submodule github.com/open-policy-agent/frameworks/constraint is not tagged. According to Go Modules wiki, submodule should be tagged like relative-path-to-root/vX.X.X.
At now, when trying to import package github.com/open-policy-agent/frameworks/constraint/pkg/client, downstream would depends on pseudo-version of module github.com/open-policy-agent/frameworks/constraint.

github.com/open-policy-agent/frameworks/constraint v0.0.0-20220121182312-5d06dedcafb4

I think it is not very readable and difficult to upgrade. This is not conductive to version control either.
So, I propose whether it is possible to tag submodule properly. For example, constraint/v0.0.1, constraint/v0.8.0etc, so that other project can use tag to import this module in go.mod.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing the multi-module layout and the go.mod files for github.com/open-policy-agent/frameworks/constraint, then compare the current tags with the Go Modules wiki guidance. Done means determining and documenting whether the constraint submodule should receive relative-path version tags such as constraint/v0.0.1.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
build-system, release
Issue type
Feature
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.