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

CodeCompliance_Engine: Check Adapter namespaces contain external #181

Open
FraserGreenroyd opened this issue Mar 9, 2020 · 1 comment
Open
Assignees
Labels
type:feature New capability or enhancement type:question Ask for further details or start conversation

Comments

@FraserGreenroyd
Copy link
Contributor

Linked to: 1) #72 (comment)

And: 2) BHoM/BHoM_Adapter#210

And: 3) #72 (comment)

There is a new compliance rule that adapter projects namespace should be as described in 2 above.

However, we have previously found that namespace checking can be tricky to cover for all situations when running CI checks. Previously we did it based on the filepath which looked for the toolkit name, but this prevented the ability to inject into existing namespaces without flagging as a CI fail.

We would need a similar set of discrete rules which allow the CI to know if a namespace should include the External keyword or not.

This issue is to discuss that, and see if such a set of clear rules can be found that will allow for the creation of a CI check to aid us in keeping compliance on this new rule.

@FraserGreenroyd FraserGreenroyd added type:feature New capability or enhancement type:question Ask for further details or start conversation labels Mar 9, 2020
@FraserGreenroyd FraserGreenroyd added this to the BHoM 3.2 β MVP milestone Mar 9, 2020
@IsakNaslundBh
Copy link
Contributor

Not sure if simple from the CI but could we check:

  1. Does the toolkit contain an adapter, (except for the BHoM adapter)
  2. If yes, does the file sit in a oM/Engine of this toolkit
  3. Does the namespace contain the first part of the toolkit (i.e. Robot, Tas etc.)
  4. If yes, the third word of the namespace should be "External" (after BH and oM/Engine).

Would that be easily doable? Basically, first pre-check if you need to run the check at all by checking if an adapter exists in the repo, then check the namespace based on repo.

@adecler adecler removed their assignment Jan 7, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:feature New capability or enhancement type:question Ask for further details or start conversation
Projects
None yet
Development

No branches or pull requests

6 participants