feat: add source repo comments to most files (#11)

Signed-off-by: M. Fatih Cırıt <[email protected]>

README.md

@@ -1 +1,11 @@
 # sync-file-templates
+
+This repository contains templates for files used across various Autoware repositories. It is utilized by the [sync-files](https://github.com/autowarefoundation/autoware-github-actions/tree/main/sync-files) GitHub Action to synchronize files between repositories.
+
+## Setup and usage
+
+For detailed instructions on how to set up and use the sync-files workflow, refer to the [sync-files README](https://github.com/autowarefoundation/autoware-github-actions/tree/main/sync-files#readme).
+
+## Example configuration
+
+Refer to the [autoware/.github/sync-files.yaml](https://github.com/autowarefoundation/autoware/blob/main/.github/sync-files.yaml) file in the Autoware repository for an example configuration.

sources/.clang-format

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 # Modified from https://github.com/ament/ament_lint/blob/master/ament_clang_format/ament_clang_format/configuration/.clang-format
 Language: Cpp
 BasedOnStyle: Google

sources/.clang-tidy

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 Checks: "
   -*,
   boost-use-to-string,

sources/.github/ISSUE_TEMPLATE/bug.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: Bug
 description: Report a bug
 body:

sources/.github/ISSUE_TEMPLATE/config.yml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 blank_issues_enabled: false
 contact_links:
   - name: Question

sources/.github/ISSUE_TEMPLATE/task.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: Task
 description: Plan a task
 body:

sources/.github/dependabot.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 version: 2
 updates:
   - package-ecosystem: github-actions

sources/.github/stale.yml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 # Modified from https://github.com/probot/stale#usage
 
 # Number of days of inactivity before an Issue or Pull Request with the stale label is closed

sources/.github/workflows/build-and-test-differential.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: build-and-test-differential
 
 on:

sources/.github/workflows/build-and-test.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: build-and-test
 
 on:

sources/.github/workflows/cancel-previous-workflows.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: cancel-previous-workflows
 
 on:

sources/.github/workflows/check-build-depends.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: check-build-depends
 
 on:

sources/.github/workflows/clang-tidy-pr-comments-manually.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: clang-tidy-pr-comments-manually
 
 on:

sources/.github/workflows/clang-tidy-pr-comments.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: clang-tidy-pr-comments
 
 on:

sources/.github/workflows/comment-on-pr.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: comment-on-pr
 on:
   pull_request_target:

sources/.github/workflows/delete-closed-pr-docs.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: delete-closed-pr-docs
 
 on:

sources/.github/workflows/deploy-docs.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: deploy-docs
 
 on:

sources/.github/workflows/github-release.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: github-release
 
 on:

sources/.github/workflows/pr-agent.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: PR-Agent
 
 on:

sources/.github/workflows/pre-commit-autoupdate.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: pre-commit-autoupdate
 
 on:

sources/.github/workflows/pre-commit-optional-autoupdate.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: pre-commit-optional-autoupdate
 
 on:

sources/.github/workflows/pre-commit-optional.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: pre-commit-optional
 
 on:

sources/.github/workflows/pre-commit.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: pre-commit
 
 on:

sources/.github/workflows/semantic-pull-request.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: semantic-pull-request
 
 on:

sources/.github/workflows/spell-check-daily.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: spell-check-daily
 
 on:

sources/.github/workflows/spell-check-differential.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: spell-check-differential
 
 on:

sources/.github/workflows/sync-files.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: sync-files
 
 on:

sources/.github/workflows/update-codeowners-from-packages.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 name: update-codeowners-from-packages
 
 on:

sources/.markdownlint.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 # See https://github.com/DavidAnson/markdownlint/blob/main/doc/Rules.md for all rules.
 default: true
 MD013: false

sources/.pre-commit-config-optional.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 repos:
   - repo: https://github.com/tcort/markdown-link-check
     rev: v3.12.2

sources/.pre-commit-config.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 ci:
   autofix_commit_msg: "style(pre-commit): autofix"
 

sources/.prettierignore

@@ -1,2 +1,6 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 *.param.yaml
 *.rviz

sources/.prettierrc.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 printWidth: 100
 tabWidth: 2
 overrides:

sources/.yamllint.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 extends: default
 
 ignore: |

sources/CPPLINT.cfg

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 # Modified from https://github.com/ament/ament_lint/blob/ebd524bb9973d5ec1dc48a670ce54f958a5a0243/ament_cpplint/ament_cpplint/main.py#L64-L120
 set noparent
 linelength=100

sources/codecov.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 coverage:
   status:
     project:

sources/docs/assets/js/mathjax.js

@@ -1,3 +1,7 @@
+// This file is automatically synced from:
+// https://github.com/autowarefoundation/sync-file-templates
+// To make changes, update the source repository and follow the guidelines in its README.
+
 window.MathJax = {
   tex: {
     inlineMath: [["\\(", "\\)"]],

sources/mkdocs.yaml

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 site_name: Autoware Documentation
 site_url: https://autowarefoundation.github.io/autoware-documentation
 repo_url: https://github.com/autowarefoundation/autoware

sources/setup.cfg

@@ -1,3 +1,7 @@
+# This file is automatically synced from:
+# https://github.com/autowarefoundation/sync-file-templates
+# To make changes, update the source repository and follow the guidelines in its README.
+
 [flake8]
 # Modified from https://github.com/ament/ament_lint/blob/ebd524bb9973d5ec1dc48a670ce54f958a5a0243/ament_flake8/ament_flake8/configuration/ament_flake8.ini
 extend-ignore = B902,C816,D100,D101,D102,D103,D104,D105,D106,D107,D203,D212,D404,I202,CNL100,E203,E501,Q000