Sync files (mainly MD) from .github to other repos #16

yada · 2024-06-18T10:56:59Z

Reason/Context

We need to use the .github repo as our single source of truth for all the community health files we would generally have to duplicate in each (or multiple) repository.
All community contributions on these files (PR) will be accepted in this repo (.github) and synced to the others; no update on the destination repo will be allowed.

Warning: any new files (new creation) must be added to the exclusion regex of each repo/workflow auto-build process, ex:
https://github.com/microcks/microcks/blob/master/.github/workflows/build-verify.yml

Description

The current files concerned are:

.github/ADOPTERS.md
.github/BACKERS.md
.github/CHANGELOG.md
.github/CODE_OF_CONDUCT.md
.github/CONTRIBUTING.md
.github/GOVERNANCE.md
.github/MAINTAINERS.md
.github/ROADMAP.md
.github/SECURITY.md

⚠️ All of them need to be first added to the exclusion regex of each repo/workflow auto-build process ⚠️

Implementation ideas

Sync for each file proposition is:

.github/ADOPTERS.md 👉 sync to all Microcks' repos
.github/BACKERS.md 👉 sync to all Microcks' repos
.github/CHANGELOG.md 👉 sync to Microcks main repo only
.github/CODE_OF_CONDUCT.md 👉 sync to all Microcks' repos
.github/CONTRIBUTING.md 👉 sync to all Microcks' repos
.github/GOVERNANCE.md 👉 sync to all Microcks' repos
.github/MAINTAINERS.md 👉 sync to all Microcks' repos IF maintainers for specific repos are in the same file TODO?
.github/ROADMAP.md 👉 sync to all Microcks' repos
.github/SECURITY.md 👉 sync to all Microcks' repos

Ideally, the sync process needs to be fully automated using GitHub actions:

on each merge, file changes
replace (if it exists also) destination files

yada · 2024-06-18T11:01:21Z

List of tasks to perform and take care of in order of priority and execution:

Agree on the list of files concerned (any files not in .github we may have missed?)
Agree on file destinations (from .github to repo)
Update ALL exclusion regex of each repo/workflow auto-build process (each repo concerned)
Sync GitHub action to find, test and put in .github workflow

yada · 2024-06-28T16:57:06Z

By the way, we should add the LICENSE file (Apache License 2.0) to this repo so we can copy it (sync) to the others.
Ex: sync to https://github.com/microcks/community

yada · 2024-07-31T12:53:03Z

GitHub action that can help from our AsyncAPI friends:
https://github.com/derberg/manage-files-in-multiple-repositories?tab=readme-ov-file

lbroudoux · 2024-08-20T13:51:11Z

I think the first step is to define the different kinds of repos we have under the Microcks organization. As those different kinds of repos don't have the same licensing or security scanning requirements, this could help us putting the right effot as the right place.

I see at least 4 different categories of repositories:

Repos that host delivered components - microcks, microcks-testcontainers-java, microcks-operator, microcks-quarkus, etc..
Repos that host demonstrations - microcks-quarkus-demo, microcks-testcontainers-node-nest-demo, api-lifecycle, api-tooling, etc...
Repos that host documentation - microcks.io and microcks.github.io
Repos that contain community resources - .github, community-mocks, microcks-quickstarters, etc...

At first, I was wondering if repos containing ecosystem plugins (like Jenkins plugin, Backstage plugin, etc...) had to be considered differently but it's still components we're delivering for and that targets production usage. So it fits in the 1st category.

What do you think? Do you agree with this way of sorting things?

Now what is the impact of this categorization? I see we have different needs and constraints depending on the type of repo.

Needs/Constraints	Delivered components	Demonstrations	Documentation	Community resources
Apache 2.0 License	✅		✅
Licence Scanning	✅
Security Scanning	✅
Security Infos	✅			✅
QA Scanning	✅
MIT License		✅		✅
Infos in README	✅	✅	✅	✅
Dependency Policy	✅	✅	✅	✅
Codeowners	✅	✅	✅	✅
Maintainers	✅	✅	✅	✅
Contribution guide	✅		✅	✅
Staling of issues	✅
Governance infos	✅		✅	✅
Changelog infos	✅
Roadmap infos	✅
Adopters & Backers infos	✅			✅
Code of conduct	✅	✅	✅	✅
Welcome new users	✅	✅	✅	✅
CLO Monitor (*1)/LFX Insights presence	✅ with `code` and `community` checks		✅ with `docs` checks

In addition, putting Security, License or QA Scanning in place has some consequences as we also need to set up some additiional tools like Sonar (QA & Security), FOSSA (License) and Quay.io/Docker Scout (Security of container image).

Also, all the files mentioned above cannot be synced as-is. Typically:

The CHANGELOG.md is specific for each repo as it contains a link to the repo releases
The CONTRIBUTING.md file is quite generic but may require some repo-specific information on build tools and others.

(*1): See, CLOMonitor checks description: https://clomonitor.io/docs/topics/checks/

yada · 2024-08-20T13:56:57Z

Make sense and looks good to me 👍

lbroudoux · 2024-08-21T09:02:30Z

Comprehensive list in different repos categories (as of today 😉)

Delivered components

microcks
microcks-cli
microcks-operator
microcks-ansible-operator
microcks-postman-runtime
microcks-testcontainers-java
microcks-testcontainers-go
microcks-testcontainers-node
microcks-quarkus
microcks-java-client
microcks-go-client
microcks-docker-desktop-extension
microcks-backstage-provider
microcks-jenkins-plugin
microcks-spectral-ruleset
import-github-action
test-github-action
hub.microcks.io

Demonstrations

microcks-testcontainers-java-spring-demo
microcks-testcontainers-node-nest-demo
microcks-testcontainers-go-demo
api-lifecycle
api-tooling

Documentation

microcks.io

Community resources

.github
community
microcks-quickstarters
community-mocks

yada · 2024-08-21T13:11:01Z

I think we also need to include some workflow, ex: welcome-new-users.yml can be copied to all repos @lbroudoux agree?

yada · 2024-08-21T13:17:38Z

As a test and first workflow for this issue, let's start by replicating CODE_OF_CONDUCT.md to all repos:

Update ALL exclusion regex of each repo/workflow auto-build process
Activate replication workflow for CoC
Validate and update it for the other files

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16 Signed-off-by: Yacine Kheddache <yacine@microcks.io>

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16 Signed-off-by: Yacine Kheddache <yacine@microcks.io>

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16

Signed-off-by: Yacine Kheddache <yacine@microcks.io>

Exclude all MD files, ref: microcks/.github#16

yada · 2024-09-11T00:01:09Z

Sync and merged in all repos as described above done ✅ for files:

Adopters infos
Code of conduct

Signed-off-by: Yacine Kheddache <yacine@microcks.io>

yada · 2024-09-24T15:46:11Z

#16 (comment) updated for #22

yada · 2024-09-24T18:12:50Z

#16 (comment) updated for #21

lbroudoux · 2024-10-16T13:47:44Z

A suggestion: we should update some PR descriptions that are not 100% correct according to semantic commit messages practices.

Typically, synchronization of files like ADOPTERS, BACKERS, GOVERNANCE, CODE_OF_CONDUCT, etc... should be marked as chore: update ADOPTERS.md from global .github repo and not not ci: ....

Stale issues management and welcoming new users tasks should be kept as ci: ...

yada · 2024-10-16T14:30:45Z

@lbroudoux Good point +1

github-actions · 2024-11-16T00:18:29Z

This issue has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 30 days if no further activity occurs. To unstale this issue, add a comment with a detailed explanation.

There can be many reasons why some specific issue has no activity. The most probable cause is lack of time, not lack of interest. Microcks is a Cloud Native Computing Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this issue forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

yada assigned yada and lbroudoux Jun 18, 2024

yada added a commit to microcks/microcks-cli that referenced this issue Aug 21, 2024

Update build-verify.yml to exclude CODE_OF_CONDUCT*

5c93f06

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16

yada added a commit to microcks/microcks-operator that referenced this issue Aug 21, 2024

Update build-verify.yml to exclude CODE_OF_CONDUCT*

243700c

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16

yada added a commit to microcks/microcks-ansible-operator that referenced this issue Aug 21, 2024

Update build-verify.yml to exclude CODE_OF_CONDUCT*

807146d

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16

yada added a commit to microcks/microcks-postman-runtime that referenced this issue Aug 21, 2024

Update build-package.yml to exclude CODE_OF_CONDUCT*

97b3c50

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16

yada added a commit to microcks/microcks-testcontainers-java that referenced this issue Aug 21, 2024

Update build-verify.yml to exclude CODE_OF_CONDUCT*

638c987

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16

yada added a commit to microcks/microcks-testcontainers-node that referenced this issue Aug 21, 2024

Update build-verify.yml to exclude CODE_OF_CONDUCT*

d0f5704

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16

yada added a commit to microcks/microcks-java-client that referenced this issue Aug 21, 2024

Update build-verify.yml to exclude CODE_OF_CONDUCT*

fa08f27

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16

yada added a commit to microcks/microcks-docker-desktop-extension that referenced this issue Aug 21, 2024

Update build-verify.yml to exclude CODE_OF_CONDUCT*

6d321f6

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16

yada added a commit to microcks/microcks-backstage-provider that referenced this issue Aug 21, 2024

Update build-verify.yml to exclude CODE_OF_CONDUCT*

407ae25

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16

yada added a commit to microcks/microcks-jenkins-plugin that referenced this issue Aug 21, 2024

Update build-verify.yml to exclude CODE_OF_CONDUCT*

adce1af

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16

yada added a commit to microcks/hub.microcks.io that referenced this issue Aug 21, 2024

Update build-verify.yml to exclude CODE_OF_CONDUCT*

d0371ed

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16

yada added a commit to microcks/microcks-testcontainers-node-nest-demo that referenced this issue Aug 21, 2024

Update build-verify.yml to exclude CODE_OF_CONDUCT*

f9f0a04

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16

This was referenced Aug 21, 2024

Add exclusion rule to build-test.yml microcks/microcks-testcontainers-java-spring-demo#24

Closed

Add exclusion rule to build-test.yml microcks/microcks-testcontainers-go-demo#5

Closed

yada added a commit to microcks/api-lifecycle that referenced this issue Aug 21, 2024

Update build-package.yml to exclude CODE_OF_CONDUCT*

27d1b44

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16

yada added a commit to microcks/api-tooling that referenced this issue Aug 21, 2024

Update build-package.yml to exclude CODE_OF_CONDUCT*

d903687

Add CODE_OF_CONDUCT to exclusion regex to avoid repo/workflow auto-build process issues, ref: microcks/.github#16

yada mentioned this issue Aug 21, 2024

Add exclusion rule to validate-artifacts.yml microcks/community-mocks#5

Closed

yada added a commit that referenced this issue Aug 23, 2024

Activate and test replication workflow for CoC #16

6bb6732

Signed-off-by: Yacine Kheddache <yacine@microcks.io>

yada added a commit to microcks/community-module-registry that referenced this issue Sep 10, 2024

Update deploy.yml to exclude all MD files

47a90cb

Exclude all MD files, ref: microcks/.github#16

yada added a commit that referenced this issue Sep 20, 2024

.github/workflows/global-replicator.yml to all repos concerned #16

305375b

Signed-off-by: Yacine Kheddache <yacine@microcks.io>

This was referenced Sep 23, 2024

Update and sync MAINTAINERS.md #18

Closed

Sync CODEOWNERS, action plan #19

Closed

Add and sync DEPENDENCY_POLICY.md #20

Closed

yada added a commit that referenced this issue Sep 23, 2024

Add replicate_dependency_policy job for #16 and #20

7bedfc8

Signed-off-by: Yacine Kheddache <yacine@microcks.io>

This was referenced Sep 24, 2024

Dependency Policy sync repos update and cleanup #21

Closed

Promote Microcks Sponsors by Sharing BACKERS.md Across All Repos #22

Closed

This was referenced Oct 16, 2024

Add Welcome new user to our global replicator action #27

Closed

Update global replicator commit message to use chore: instead of ci: #28

Closed

github-actions bot added the stale label Nov 16, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Sync files (mainly MD) from .github to other repos #16

Sync files (mainly MD) from .github to other repos #16

yada commented Jun 18, 2024

yada commented Jun 18, 2024 •

edited

Loading

yada commented Jun 28, 2024

yada commented Jul 31, 2024

lbroudoux commented Aug 20, 2024 •

edited by yada

Loading

yada commented Aug 20, 2024

lbroudoux commented Aug 21, 2024 •

edited by yada

Loading

yada commented Aug 21, 2024

yada commented Aug 21, 2024 •

edited

Loading

yada commented Sep 11, 2024

yada commented Sep 24, 2024

yada commented Sep 24, 2024

lbroudoux commented Oct 16, 2024 •

edited

Loading

yada commented Oct 16, 2024

github-actions bot commented Nov 16, 2024

Sync files (mainly MD) from .github to other repos #16

Sync files (mainly MD) from .github to other repos #16

Comments

yada commented Jun 18, 2024

Reason/Context

Description

Implementation ideas

yada commented Jun 18, 2024 • edited Loading

yada commented Jun 28, 2024

yada commented Jul 31, 2024

lbroudoux commented Aug 20, 2024 • edited by yada Loading

yada commented Aug 20, 2024

lbroudoux commented Aug 21, 2024 • edited by yada Loading

yada commented Aug 21, 2024

yada commented Aug 21, 2024 • edited Loading

yada commented Sep 11, 2024

yada commented Sep 24, 2024

yada commented Sep 24, 2024

lbroudoux commented Oct 16, 2024 • edited Loading

yada commented Oct 16, 2024

github-actions bot commented Nov 16, 2024

yada commented Jun 18, 2024 •

edited

Loading

lbroudoux commented Aug 20, 2024 •

edited by yada

Loading

lbroudoux commented Aug 21, 2024 •

edited by yada

Loading

yada commented Aug 21, 2024 •

edited

Loading

lbroudoux commented Oct 16, 2024 •

edited

Loading