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

Policy on reusable workflows for document repositories #115

Closed
ronaldtse opened this issue Jul 7, 2023 · 3 comments
Closed

Policy on reusable workflows for document repositories #115

ronaldtse opened this issue Jul 7, 2023 · 3 comments
Assignees
Labels
enhancement New feature or request

Comments

@ronaldtse
Copy link
Contributor

There are 3 types of document repositories:

  1. End-user document repositories. These only need the simplest build workflow and provides the artifacts for the user to download.
  2. CI document repositories. These repositories are the core release tests for Metanorma and they need to be built in many ways.
  3. Internal document repositories. These repositories are tests for Metanorma, and need to be tested in many ways, but they are not blockers for the CI flow.

For public repositories that require private fonts, they can use those fonts.

Currently we have "two kinds of workflows" (as per @CAMOBAP):

  • "internal" we just reuse workflow from metanorma/ci. It's not for the end users, because it's hard to read it, but they are general and cover almost all our document repos.
  • "end-user" workflow like S-102-Product-Specification. It's compact, much easier to understand because it the self-contained, but they don't cover all use cases.

Originally posted by @CAMOBAP in https://github.com/metanorma/iso-10303-2/issues/286#issuecomment-1624777447

@CAMOBAP
Copy link
Contributor

CAMOBAP commented Jul 7, 2023

@ronaldtse thanks for the answers, let me specify:

  1. can I assume that all public repositories except mn-samples-* are end-user document repositories?
  2. it's mn-sample-* repository only, right?
  3. private repositories i.e. iso-* ones, right?

@ronaldtse
Copy link
Contributor Author

CI document repositories.

  • mn-samples-* (public + private)
  • mn-templates-* (public + private)

Internal document repositories

I actually don't have a list of particular repos we want to test with outside the ones above.

End-user repositories

All public and private repositories should be considered end-user repositories.

@CAMOBAP
Copy link
Contributor

CAMOBAP commented Sep 6, 2023

Document repos updated

@CAMOBAP CAMOBAP closed this as completed Sep 6, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants