diff --git a/.github/dependencies.py b/.github/dependencies.py new file mode 100644 index 000000000..92338059c --- /dev/null +++ b/.github/dependencies.py @@ -0,0 +1,157 @@ +import os +import re +import yaml + + +DEPENDENCIES_SUBSECTION_TITLE = "Dependencies" +DEPENDENCIES_PLACEHOLDER = ['## Dependencies', + 'No external actions in use here.'] + + +def create_non_existing_docu(file_path: str, placeholder: list): + # Create the dir in case documentation is not created yet + directory_path = os.path.dirname(file_path) + os.makedirs(directory_path, exist_ok=True) + + # Create Readme if it does not exist yet + ci_name = os.path.basename(directory_path) + file_exist = os.path.exists(file_path) + if not file_exist: + with open(file_path, 'w') as file: + file.write(f"# Documentation for {ci_name}\n") + for line in placeholder: + file.write(line + "\n") + + +def read_file(file_path: str): + with open(file_path, 'r') as file: + content = file.read() + return content + + +def remove_formatting(content): + # Remove whitespaces and newlines and hyphens + try: + return content.replace( + " ", "").replace("\n", "").replace("-", "") + except Exception as e: + print(f"An error occurred: {e}") + + +def replace_string_in_markdown(file_path, old_string, new_string): + content = read_file(file_path) + modified_content = content.replace(old_string, new_string) + with open(file_path, 'w') as file: + file.write(modified_content) + + +def contents_equal(file1, file2): + content1 = remove_formatting(file1) + content2 = remove_formatting(file2) + + return content1 == content2 + + +def extract_subsection_content(markdown_content, subsection_title): + # Defines the pattern for detecting headers (## Subsection Title) + pattern = re.compile( + r'^##\s' + re.escape(subsection_title) + r'\s*$', re.MULTILINE) + + # Finds the start and end positions of the subsection + match = pattern.search(markdown_content) + if match: + start_position = match.end() + next_header = pattern.search(markdown_content[start_position:]) + if next_header: + end_position = next_header.start() + start_position + else: + end_position = len(markdown_content) + + # Extracs the content of the subsection + subsection_content = markdown_content[start_position:end_position].strip( + ) + return subsection_content + else: + return None + + +def extract_dependencies(ci_file): + uses_values = [] + + with open(ci_file, 'r') as file: + yaml_data = yaml.safe_load(file) + + if isinstance(yaml_data, dict): + for key, run in yaml_data.items(): + if key == "runs": + if isinstance(run, dict): + steps = run.get("steps", []) + if isinstance(steps, list): + for step in steps: + if isinstance(step, dict): + uses_value = step.get("uses") + if uses_value is not None: + uses_values.append(uses_value) + elif key == "jobs": + if isinstance(run, dict): + jobs = run.items() + for _, job in jobs: + steps = job.get("steps", []) + if isinstance(steps, list): + for step in steps: + if isinstance(step, dict): + uses_value = step.get("uses") + if uses_value is not None: + uses_values.append(uses_value) + + return uses_values + + +def generate_links(used_ci): + dependencies = [] + for dep in used_ci: + link = "" + dependency_link = "" + base = "https://github.com/" + if "bakdata" in dep: + separator = "ci-templates/" + prefix, sufix = dep.split(separator) + base += prefix + separator + sufix, tag = sufix.split("@") + tag = f"blob/{tag}/" + link = base + tag + sufix + else: + link = base + dep.replace("@", "/tree/") + + dependency_link = f"- [{dep}]({link})\n" + dependencies.append(dependency_link) + + return dependencies + + +def update_dependencies(readme_path: str, dependencies: list): + updated = False + + create_non_existing_docu(file_path=readme_path, + placeholder=DEPENDENCIES_PLACEHOLDER) + if dependencies: + readme_content = read_file(readme_path) + + if f"## {DEPENDENCIES_SUBSECTION_TITLE}" not in readme_content: + try: + with open(readme_path, 'a') as file_readme: + for line in DEPENDENCIES_PLACEHOLDER: + file_readme.write(line + "\n") + file_readme.write("\n") + except Exception as e: + print(f"An error occurred: {e}") + new_readme_content = read_file(readme_path) + readme_extraction_result = extract_subsection_content( + new_readme_content, DEPENDENCIES_SUBSECTION_TITLE) + param_join_result = ''.join(dependencies) + dependencies_subsection = readme_extraction_result.split("\n## ")[0] + if not contents_equal(dependencies_subsection, param_join_result): + replace_string_in_markdown( + readme_path, dependencies_subsection, param_join_result) + updated = True + return updated diff --git a/.github/generate-doc.py b/.github/generate-doc.py index 8e00f36dc..97228355c 100644 --- a/.github/generate-doc.py +++ b/.github/generate-doc.py @@ -1,10 +1,9 @@ +from dependencies import create_non_existing_docu, contents_equal, extract_dependencies, extract_subsection_content, generate_links, read_file, replace_string_in_markdown, update_dependencies import glob import os -import re import shutil import subprocess - TARGET_SUBSECTION_TITLE = 'References' README_FILE = "README.md" @@ -17,48 +16,8 @@ class Colors: RESET = '\033[0m' -def replace_string_in_markdown(file_path, old_string, new_string): - with open(file_path, 'r') as file: - content = file.read() - modified_content = content.replace(old_string, new_string) - with open(file_path, 'w') as file: - file.write(modified_content) - - -def extract_subsection_content(markdown_content, subsection_title): - # Define the pattern for detecting headers (## Subsection Title) - pattern = re.compile( - r'^##\s' + re.escape(subsection_title) + r'\s*$', re.MULTILINE) - - # Find the start and end positions of the subsection - match = pattern.search(markdown_content) - if match: - start_position = match.end() - next_header = pattern.search(markdown_content[start_position:]) - end_position = next_header.start() if next_header else len(markdown_content) - - # Extract the content of the subsection - subsection_content = markdown_content[start_position:end_position].strip( - ) - return subsection_content - else: - return None - - -def remove_formatting(content): - # Remove whitespaces and newlines and hyphens - try: - return content.replace( - " ", "").replace("\n", "").replace("-", "") - except Exception as e: - print(f"An error occurred: {e}") - - -def contents_equal(file1, file2): - content1 = remove_formatting(file1) - content2 = remove_formatting(file2) - - return content1 == content2 +def print_colored(text, color): + print(f"{color}{text}{Colors.RESET}") def update_doc(readme_path, reference_path): @@ -66,23 +25,11 @@ def update_doc(readme_path, reference_path): '### Subsubsection', 'Placeholder'] updated = False - # Create the dir in case documentation is not created yet - directory_path = os.path.dirname(readme_path) - os.makedirs(directory_path, exist_ok=True) + create_non_existing_docu(file_path=readme_path, + placeholder=subsection_placeholder) - # Create Readme if it does not exist yet - ci_name = os.path.basename(directory_path) - file_exist = os.path.exists(readme_path) - if not file_exist: - with open(readme_path, 'w') as file: - file.write(f"# Documentation for {ci_name}") - for line in subsection_placeholder: - file.write(line + "\n") - - with open(readme_path, 'r') as file1: - readme_content = file1.read() - with open(reference_path, 'r') as file2: - reference_content = file2.read() + readme_content = read_file(readme_path) + reference_content = read_file(reference_path) # add subsection if it does not exist if f"## {TARGET_SUBSECTION_TITLE}" not in readme_content: @@ -92,16 +39,17 @@ def update_doc(readme_path, reference_path): file_readme.write(line + "\n") except Exception as e: print(f"An error occurred: {e}") - + new_readme_content = read_file(readme_path) readme_extraction_result = extract_subsection_content( - readme_content, TARGET_SUBSECTION_TITLE) + new_readme_content, TARGET_SUBSECTION_TITLE) + readme_references_subsection = readme_extraction_result.split("\n## ")[0] reference_extraction_result = extract_subsection_content( reference_content, TARGET_SUBSECTION_TITLE) - if not contents_equal(readme_extraction_result, reference_extraction_result): + if not contents_equal(readme_references_subsection, reference_extraction_result): replace_string_in_markdown( - readme_path, readme_extraction_result, reference_extraction_result) + readme_path, readme_references_subsection, reference_extraction_result) updated = True return updated @@ -119,10 +67,6 @@ def auto_doc_installed(): return f"Error: {e.stderr}" -def print_colored(text, color): - print(f"{color}{text}{Colors.RESET}") - - class DocGenerationError(Exception): def __init__(self, count, inconsistencies): inconsistencies_str = f"{Colors.RED}Error: The documentation is not up to date. {count} inconsistency(ies) where found. Re running pre-commit may help. Inconstencies:\n{Colors.RESET}" @@ -177,7 +121,13 @@ def run(): action_files = glob.glob("actions/**/action.yaml") action_files.extend(glob.glob("actions/**/action.yml")) for action_file in action_files: + + # generate a list of dependencies containing links to GH-repos + action_dependencies = extract_dependencies(action_file) + action_dependencies_links = generate_links(action_dependencies) + action_name = os.path.basename(os.path.dirname(action_file)) + # create docu in tmp dir output_dir_action = f"docs/actions/{action_name}" tmp_docu_output_dir = os.path.join( @@ -196,8 +146,10 @@ def run(): output_file_action = os.path.join( output_dir_action, README_FILE) + changes.append({"readme": output_file_action, - "tmp_output": tmp_docu_output_action}) + "tmp_output": tmp_docu_output_action, + "dependencies": action_dependencies_links}) # go through workflows tmp_workflow = "tmps/workflows" @@ -207,6 +159,11 @@ def run(): for workflow in os.listdir(workflow_dir): workflow_name = workflow.split(".")[0] if not workflow.startswith("_") and workflow != README_FILE: + + # generate a list of dependencies containing links to GH-repos + workflow_dependencies = extract_dependencies(action_file) + workflow_dependencies_links = generate_links(workflow_dependencies) + workflow_path = os.path.join(workflow_dir, workflow) output_dir_workflow = f"docs/workflows/{workflow_name}" @@ -232,7 +189,8 @@ def run(): output_dir_workflow, README_FILE) changes.append({"readme": workflow_doc_file, - "tmp_output": tmp_docu_output_workflow}) + "tmp_output": tmp_docu_output_workflow, + "dependencies": workflow_dependencies_links}) # Correction count = 0 @@ -240,8 +198,14 @@ def run(): for entry in changes: readme_f = entry["readme"] tmp_f = entry["tmp_output"] + dependencies_found = entry["dependencies"] + + dep_updated = update_dependencies( + readme_path=readme_f, dependencies=dependencies_found) + was_updated = update_doc(readme_f, tmp_f) - if was_updated: + + if was_updated or dep_updated: inconsistencies.append(readme_f) count += 1 if count == 0: diff --git a/.github/workflows/README.md b/.github/workflows/README.md index 2a2687300..789ce6b54 100644 --- a/.github/workflows/README.md +++ b/.github/workflows/README.md @@ -20,75 +20,60 @@ The following workflows can be found here: ## Bump version release -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/bump-version-release) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/workflows/bump-version-release) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/bump-version-release) ## Docker Build and Publish -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/docker-build-and-publish) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/workflows/docker-build-and-publish) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/docker-build-and-publish) ## Helm Multi Release -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/helm-multi-release) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/workflows/bump-version-release) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/helm-multi-release) ## Helm Release -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/helm-release) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/workflows/helm-release) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/helm-release) ## Java Gradle Base -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/java-gradle-base) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/workflows/java-gradle-base) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/java-gradle-base) ## Java Gradle Docker -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/java-gradle-docker) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/workflows/java-gradle-docker) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/java-gradle-docker) ## Java Gradle Library -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/java-gradle-library) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/workflows/java-gradle-library) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/java-gradle-library) ## Java Gradle Plugin -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/java-gradle-plugin) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/workflows/java-gradle-plugin) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/java-gradle-plugin) ## Java Gradle Release -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/java-gradle-release) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/workflows/java-gradle-release) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/java-gradle-release) ## Kustomize GKE Deploy -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/kustomize-gke-deploy) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/workflows/kustomize-gke-deploy) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/kustomize-gke-deploy) ## Kustomize GKE Destroy -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/kustomize-gke-destroy) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/workflows/kustomize-gke-destroy) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/kustomize-gke-destroy) ## Python Poetry Publish PyPI -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/python-poetry-publish-pypi) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/workflows/python-poetry-publish-pypi) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/python-poetry-publish-pypi) ## Python Poetry Publish Snapshot -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/python-poetry-publish-snapshot) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/workflows/python-poetry-publish-snapshot) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/python-poetry-publish-snapshot) ## Python Poetry Release -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/python-poetry-release) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/workflows/python-poetry-release) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/python-poetry-release) ## Release Tag Versions -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/release-tag-versions) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/workflows/release-tag-versions) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/workflows/release-tag-versions) diff --git a/.github/workflows/_pre-commit-check.yaml b/.github/workflows/_pre-commit-check.yaml index 946da0c31..15ef54019 100644 --- a/.github/workflows/_pre-commit-check.yaml +++ b/.github/workflows/_pre-commit-check.yaml @@ -10,11 +10,14 @@ jobs: - name: Checkout code uses: actions/checkout@v3 - - name: Installation + - name: Installations run: | + # install pre-commit pip install pre-commit wget https://github.com/tj-actions/auto-doc/releases/download/v3.4.0/auto-doc_3.4.0_Linux_x86_64.tar.gz tar -xf auto-doc_3.4.0_Linux_x86_64.tar.gz + # install python yaml library + pip install pyyaml working-directory: . - name: Run pre-commit diff --git a/.gitignore b/.gitignore index d01517ef2..61ce45215 100644 --- a/.gitignore +++ b/.gitignore @@ -8,3 +8,4 @@ tmp* auto-doc* ./test* +__pycache__ diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index eeccc6ca3..cc343e44e 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -2,6 +2,7 @@ repos: - repo: local hooks: - id: auto-doc + additional_dependencies: ["pyyaml"] language: python name: Generate doc entry: python3 .github/generate-doc.py diff --git a/actions/action-lint/README.md b/actions/action-lint/README.md index 78fae98ad..d84a4d26e 100644 --- a/actions/action-lint/README.md +++ b/actions/action-lint/README.md @@ -1,4 +1,3 @@ # action-lint -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/action-lint) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/action-lint) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/action-lint) diff --git a/actions/bump-version/README.md b/actions/bump-version/README.md index ec4c40d90..a821dfc23 100644 --- a/actions/bump-version/README.md +++ b/actions/bump-version/README.md @@ -1,4 +1,3 @@ # bump-version -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/bump-version) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/bump-version) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/bump-version) diff --git a/actions/changelog-generate/README.md b/actions/changelog-generate/README.md index 75fe4ef38..4a5899b5b 100644 --- a/actions/changelog-generate/README.md +++ b/actions/changelog-generate/README.md @@ -1,4 +1,3 @@ # changelog-generate -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/changelog-generate) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/changelog-generate) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/changelog-generate) diff --git a/actions/checkout/README.md b/actions/checkout/README.md index 84f73cd8f..63db95b48 100644 --- a/actions/checkout/README.md +++ b/actions/checkout/README.md @@ -1,4 +1,3 @@ # checkout -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/checkout) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/checkout) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/checkout) diff --git a/actions/commit-and-push/README.md b/actions/commit-and-push/README.md index 31684b7f8..7c09f649c 100644 --- a/actions/commit-and-push/README.md +++ b/actions/commit-and-push/README.md @@ -1,4 +1,3 @@ # commit-and-push -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/commit-and-push) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/commit-and-push) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/commit-and-push) diff --git a/actions/docker-build/README.md b/actions/docker-build/README.md index 1b2240e4f..d4316ffe1 100644 --- a/actions/docker-build/README.md +++ b/actions/docker-build/README.md @@ -1,4 +1,3 @@ # docker-build -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/docker-build) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/docker-build) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/docker-build) diff --git a/actions/docker-publish/README.md b/actions/docker-publish/README.md index ac4a4cf3f..7d14dfc31 100644 --- a/actions/docker-publish/README.md +++ b/actions/docker-publish/README.md @@ -1,4 +1,3 @@ # docker-publish -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/docker-publish) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/docker-publish) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/docker-publish) diff --git a/actions/docker-push/README.md b/actions/docker-push/README.md index aedeb19b5..af85f8c61 100644 --- a/actions/docker-push/README.md +++ b/actions/docker-push/README.md @@ -1,4 +1,3 @@ # docker-push -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/docker-push) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/docker-push) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/docker-push) diff --git a/actions/helm-deploy/README.md b/actions/helm-deploy/README.md index abfd94cc1..b8672c479 100644 --- a/actions/helm-deploy/README.md +++ b/actions/helm-deploy/README.md @@ -1,4 +1,3 @@ # helm-deploy -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/helm-deploy) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/helm-deploy) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/helm-deploy) diff --git a/actions/helm-destroy/README.md b/actions/helm-destroy/README.md index 66dcd9476..e8fe79dd3 100644 --- a/actions/helm-destroy/README.md +++ b/actions/helm-destroy/README.md @@ -1,4 +1,3 @@ # helm-destroy -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/helm-destroy) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/helm-destroy) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/helm-destroy) diff --git a/actions/helm-lint/README.md b/actions/helm-lint/README.md index d35234529..c8ab08964 100644 --- a/actions/helm-lint/README.md +++ b/actions/helm-lint/README.md @@ -1,4 +1,3 @@ # helm-lint -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/helm-lint) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/helm-lint) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/helm-lint) diff --git a/actions/helm-package/README.md b/actions/helm-package/README.md index 47baca3a5..6c383da5c 100644 --- a/actions/helm-package/README.md +++ b/actions/helm-package/README.md @@ -1,4 +1,3 @@ # helm-package -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/helm-package) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/helm-package) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/helm-package) diff --git a/actions/helm-setup/README.md b/actions/helm-setup/README.md index 778e56008..38583d7db 100644 --- a/actions/helm-setup/README.md +++ b/actions/helm-setup/README.md @@ -1,4 +1,3 @@ # helm-setup -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/helm-setup) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/helm-setup) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/helm-setup) diff --git a/actions/java-gradle-assess-code-quality/README.md b/actions/java-gradle-assess-code-quality/README.md index 6a93a4bca..f32e741a3 100644 --- a/actions/java-gradle-assess-code-quality/README.md +++ b/actions/java-gradle-assess-code-quality/README.md @@ -1,4 +1,3 @@ # assess-code-quality -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/java-gradle-assess-code-quality) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/java-gradle-assess-code-quality) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/java-gradle-assess-code-quality) diff --git a/actions/java-gradle-build-jib/README.md b/actions/java-gradle-build-jib/README.md index 6c0927b9b..629fd9b4b 100644 --- a/actions/java-gradle-build-jib/README.md +++ b/actions/java-gradle-build-jib/README.md @@ -1,4 +1,3 @@ # java-gradle-build-jib -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/java-gradle-build-jib) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/java-gradle-build-jib) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/java-gradle-build-jib) diff --git a/actions/java-gradle-build/README.md b/actions/java-gradle-build/README.md index 513052e49..60eac7ccf 100644 --- a/actions/java-gradle-build/README.md +++ b/actions/java-gradle-build/README.md @@ -1,4 +1,3 @@ # java-gradle-build -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/java-gradle-build) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/java-gradle-build) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/java-gradle-build) diff --git a/actions/java-gradle-publish-plugin/README.md b/actions/java-gradle-publish-plugin/README.md index 312706238..db09e3156 100644 --- a/actions/java-gradle-publish-plugin/README.md +++ b/actions/java-gradle-publish-plugin/README.md @@ -1,4 +1,3 @@ # java-gradle-publish-plugin -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/java-gradle-publish-plugin) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/java-gradle-publish-plugin) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/java-gradle-publish-plugin) diff --git a/actions/java-gradle-publish/README.md b/actions/java-gradle-publish/README.md index df5b6a2da..f5913fe23 100644 --- a/actions/java-gradle-publish/README.md +++ b/actions/java-gradle-publish/README.md @@ -1,4 +1,3 @@ # java-gradle-publish -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/java-gradle-publish) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/java-gradle-publish) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/java-gradle-publish) diff --git a/actions/java-gradle-release-github/README.md b/actions/java-gradle-release-github/README.md index b36a683d2..91324c632 100644 --- a/actions/java-gradle-release-github/README.md +++ b/actions/java-gradle-release-github/README.md @@ -1,4 +1,3 @@ # java-gradle-release-github -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/java-gradle-release-github) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/java-gradle-release-github) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/java-gradle-release-github) diff --git a/actions/java-gradle-release/README.md b/actions/java-gradle-release/README.md index 44070065e..39eeb673b 100644 --- a/actions/java-gradle-release/README.md +++ b/actions/java-gradle-release/README.md @@ -1,4 +1,3 @@ # java-gradle-release -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/java-gradle-release) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/java-gradle-release) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/java-gradle-release) diff --git a/actions/java-gradle-setup/README.md b/actions/java-gradle-setup/README.md index 0a3ebb770..22824d8ca 100644 --- a/actions/java-gradle-setup/README.md +++ b/actions/java-gradle-setup/README.md @@ -1,4 +1,3 @@ # java-gradle-setup -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/java-gradle-setup) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/java-gradle-setup) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/java-gradle-setup) diff --git a/actions/java-gradle-test/README.md b/actions/java-gradle-test/README.md index 114a74c46..27427e83c 100644 --- a/actions/java-gradle-test/README.md +++ b/actions/java-gradle-test/README.md @@ -1,4 +1,3 @@ # java-gradle-test -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/java-gradle-test) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/java-gradle-test) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/java-gradle-test) diff --git a/actions/java-maven-build/README.md b/actions/java-maven-build/README.md index c11f383bf..fe4d662d6 100644 --- a/actions/java-maven-build/README.md +++ b/actions/java-maven-build/README.md @@ -1,4 +1,3 @@ # java-maven-build -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/java-maven-build) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/java-maven-build) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/java-maven-build) diff --git a/actions/java-maven-release/README.md b/actions/java-maven-release/README.md index 5a677d721..4da4c850f 100644 --- a/actions/java-maven-release/README.md +++ b/actions/java-maven-release/README.md @@ -1,4 +1,3 @@ # java-maven-release -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/java-maven-release) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/java-maven-release) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/java-maven-release) diff --git a/actions/java-maven-setup/README.md b/actions/java-maven-setup/README.md index 2b0960fa7..0d56b3659 100644 --- a/actions/java-maven-setup/README.md +++ b/actions/java-maven-setup/README.md @@ -1,4 +1,3 @@ # java-maven-setup -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/java-maven-setup) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/java-maven-setup) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/java-maven-setup) diff --git a/actions/java-maven-test/README.md b/actions/java-maven-test/README.md index 84e30bef8..64d3f7e8f 100644 --- a/actions/java-maven-test/README.md +++ b/actions/java-maven-test/README.md @@ -1,4 +1,3 @@ # java-maven-test -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/java-maven-test) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/java-maven-test) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/java-maven-test) diff --git a/actions/kustomize-deploy/README.md b/actions/kustomize-deploy/README.md index a528d1e49..a55555686 100644 --- a/actions/kustomize-deploy/README.md +++ b/actions/kustomize-deploy/README.md @@ -1,4 +1,3 @@ # Kustomize-deploy -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/kustomize-deploy) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/kustomize-deploy) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/kustomize-deploy) diff --git a/actions/kustomize-destroy/README.md b/actions/kustomize-destroy/README.md index 9f8195a67..f1ff40aaa 100644 --- a/actions/kustomize-destroy/README.md +++ b/actions/kustomize-destroy/README.md @@ -1,4 +1,3 @@ # Kustomize-destroy -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/kustomize-destroy) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/kustomize-destroy) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/kustomize-destroy) diff --git a/actions/port-forward/README.md b/actions/port-forward/README.md index 32162ba7c..eafd11c74 100644 --- a/actions/port-forward/README.md +++ b/actions/port-forward/README.md @@ -1,4 +1,3 @@ # port-forward -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/port-forward) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/port-forward) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/port-forward) diff --git a/actions/python-poetry-bump-version/README.md b/actions/python-poetry-bump-version/README.md index 17b79c74d..060ea218f 100644 --- a/actions/python-poetry-bump-version/README.md +++ b/actions/python-poetry-bump-version/README.md @@ -1,4 +1,3 @@ # python-poetry-bump-version -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/python-poetry-bump-version) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/python-poetry-bump-version) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/python-poetry-bump-version) diff --git a/actions/python-poetry-publish-pypi/README.md b/actions/python-poetry-publish-pypi/README.md index f472a03fe..b34f67a06 100644 --- a/actions/python-poetry-publish-pypi/README.md +++ b/actions/python-poetry-publish-pypi/README.md @@ -1,4 +1,3 @@ # python-poetry-publish-pypi -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/python-poetry-publish-pypi) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/python-poetry-publish-pypi) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/python-poetry-publish-pypi) diff --git a/actions/python-poetry-publish/README.md b/actions/python-poetry-publish/README.md index 57b0713d8..f9f69b86a 100644 --- a/actions/python-poetry-publish/README.md +++ b/actions/python-poetry-publish/README.md @@ -1,4 +1,3 @@ # python-poetry-publish -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/python-poetry-publish) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/python-poetry-publish) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/python-poetry-publish) diff --git a/actions/python-setup-poetry/README.md b/actions/python-setup-poetry/README.md index c264f5915..b7edc6af4 100644 --- a/actions/python-setup-poetry/README.md +++ b/actions/python-setup-poetry/README.md @@ -1,4 +1,3 @@ # python-setup-poetry -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/python-setup-poetry) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/python-setup-poetry) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/python-setup-poetry) diff --git a/actions/setup-credentials/README.md b/actions/setup-credentials/README.md index b473958cf..164a65232 100644 --- a/actions/setup-credentials/README.md +++ b/actions/setup-credentials/README.md @@ -1,4 +1,3 @@ # setup-credentials -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/setup-credentials) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/setup-credentials) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/setup-credentials) diff --git a/actions/substitute-envs/README.md b/actions/substitute-envs/README.md index f0081b9eb..46d0a1a6b 100644 --- a/actions/substitute-envs/README.md +++ b/actions/substitute-envs/README.md @@ -1,4 +1,3 @@ # substitute-envs -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/substitute-envs) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/substitute-envs) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/substitute-envs) diff --git a/actions/tag-and-release/README.md b/actions/tag-and-release/README.md index 84cf557c2..2d1516d37 100644 --- a/actions/tag-and-release/README.md +++ b/actions/tag-and-release/README.md @@ -1,4 +1,3 @@ # tag-and-release -- [Description](https://github.com/bakdata/ci-templates/tree/main/docs/descriptions/actions/tag-and-release) -- [References](https://github.com/bakdata/ci-templates/tree/main/docs/references/actions/tag-and-release) +- [Documentation](https://github.com/bakdata/ci-templates/tree/main/docs/actions/tag-and-release) diff --git a/docs/actions/action-lint/README.md b/docs/actions/action-lint/README.md index 77283d24d..3cf35716f 100644 --- a/docs/actions/action-lint/README.md +++ b/docs/actions/action-lint/README.md @@ -10,6 +10,10 @@ steps: ref: "my-awesome-ref" # (Optional) ``` +## Dependencies + +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) + ## References ### Inputs diff --git a/docs/actions/changelog-generate/README.md b/docs/actions/changelog-generate/README.md index f9123570a..c7e212691 100644 --- a/docs/actions/changelog-generate/README.md +++ b/docs/actions/changelog-generate/README.md @@ -20,12 +20,6 @@ The upper bound might be either existing or new. If the new tag does not yet exist, the action will nevertheless create the changelog so that it may be included in the release. -## Dependencies - -This action is built from the following composite actions: - -- [release-changelog-builder-action](https://github.com/mikepenz/release-changelog-builder-action) - ## Prerequisites Create a file called `changelog-config.json` that contains the changelog configurations. @@ -80,6 +74,10 @@ steps: shell: bash ``` +## Dependencies + +- [mikepenz/release-changelog-builder-action@v4](https://github.com/mikepenz/release-changelog-builder-action/tree/v4) + ## References ### Inputs diff --git a/docs/actions/checkout/README.md b/docs/actions/checkout/README.md index 0ec36c84a..2691bed25 100644 --- a/docs/actions/checkout/README.md +++ b/docs/actions/checkout/README.md @@ -6,13 +6,6 @@ This composite action will checkout your repository and allow you to handle [LFS Make sure your [LFS](https://docs.github.com/en/repositories/working-with-files/managing-large-files/configuring-git-large-file-storage) is properly configured. -### Dependencies - -This workflow is built from other composite actions listed below: - -- [actions/checkout](https://github.com/actions/checkout) -- [actions/cache](https://github.com/actions/cache) - ## Usage ```yaml @@ -26,6 +19,11 @@ steps: run: ls -al . ``` +## Dependencies + +- [actions/checkout@v4](https://github.com/actions/checkout/tree/v4) +- [actions/cache@v3](https://github.com/actions/cache/tree/v3) + ## References ### Inputs diff --git a/docs/actions/commit-and-push/README.md b/docs/actions/commit-and-push/README.md index 7f5eb4dbc..ef3a951f3 100644 --- a/docs/actions/commit-and-push/README.md +++ b/docs/actions/commit-and-push/README.md @@ -31,6 +31,10 @@ steps: # Rest of the workflow steps ``` +## Dependencies + +- [ad-m/github-push-action@v0.6.0](https://github.com/ad-m/github-push-action/tree/v0.6.0) + ## References ### Inputs diff --git a/docs/actions/docker-build/README.md b/docs/actions/docker-build/README.md index 2dd47fc68..c41b1f55d 100644 --- a/docs/actions/docker-build/README.md +++ b/docs/actions/docker-build/README.md @@ -21,6 +21,10 @@ steps: working-directory: "./tarball" ``` +## Dependencies + +- [actions/upload-artifact@v3.1.1](https://github.com/actions/upload-artifact/tree/v3.1.1) + ## References ### Inputs diff --git a/docs/actions/docker-publish/README.md b/docs/actions/docker-publish/README.md index f73415567..80a534571 100644 --- a/docs/actions/docker-publish/README.md +++ b/docs/actions/docker-publish/README.md @@ -22,6 +22,12 @@ steps: working-directory: "./tarball" ``` +## Dependencies + +- [actions/download-artifact@v3](https://github.com/actions/download-artifact/tree/v3) +- [docker/setup-buildx-action@v2.2.1](https://github.com/docker/setup-buildx-action/tree/v2.2.1) +- [bakdata/ci-templates/actions/docker-push@1.30.0](https://github.com/bakdata/ci-templates/blob/1.30.0/actions/docker-push) + ## References ### Inputs diff --git a/docs/actions/docker-push/README.md b/docs/actions/docker-push/README.md index 3c9b5009e..402fc0021 100644 --- a/docs/actions/docker-push/README.md +++ b/docs/actions/docker-push/README.md @@ -21,6 +21,10 @@ steps: working-directory: "./tarball" ``` +## Dependencies + +- [docker/setup-buildx-action@v2.2.1](https://github.com/docker/setup-buildx-action/tree/v2.2.1) + ## References ### Inputs diff --git a/docs/actions/helm-lint/README.md b/docs/actions/helm-lint/README.md index a6961f87f..2d1daf28d 100644 --- a/docs/actions/helm-lint/README.md +++ b/docs/actions/helm-lint/README.md @@ -24,6 +24,12 @@ steps: helm-version: "v3.10.1" # (Optional) ``` +## Dependencies + +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [azure/setup-helm@v3](https://github.com/azure/setup-helm/tree/v3) +- [helm/chart-testing-action@v2.0.1](https://github.com/helm/chart-testing-action/tree/v2.0.1) + ## References ### Inputs diff --git a/docs/actions/helm-package/README.md b/docs/actions/helm-package/README.md index bede3921b..8e87651e6 100644 --- a/docs/actions/helm-package/README.md +++ b/docs/actions/helm-package/README.md @@ -18,6 +18,10 @@ steps: # Rest of the workflow steps ``` +## Dependencies + +- [azure/setup-helm@v3](https://github.com/azure/setup-helm/tree/v3) + ## References ### Inputs diff --git a/docs/actions/helm-setup/README.md b/docs/actions/helm-setup/README.md index b40d1feab..b2f18afc1 100644 --- a/docs/actions/helm-setup/README.md +++ b/docs/actions/helm-setup/README.md @@ -13,6 +13,11 @@ steps: helm-version: "v3.10.1" # optional ``` +## Dependencies + +- [azure/setup-kubectl@v3](https://github.com/azure/setup-kubectl/tree/v3) +- [azure/setup-helm@v3](https://github.com/azure/setup-helm/tree/v3) + ## References ### Inputs diff --git a/docs/actions/java-gradle-assess-code-quality/README.md b/docs/actions/java-gradle-assess-code-quality/README.md index 7ba5a03f7..058664284 100644 --- a/docs/actions/java-gradle-assess-code-quality/README.md +++ b/docs/actions/java-gradle-assess-code-quality/README.md @@ -20,6 +20,11 @@ steps: working-directory: "." # (Optional) ``` +## Dependencies + +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) + ## References ### Inputs diff --git a/docs/actions/java-gradle-build-jib/README.md b/docs/actions/java-gradle-build-jib/README.md index 686a83946..3dd1a3009 100644 --- a/docs/actions/java-gradle-build-jib/README.md +++ b/docs/actions/java-gradle-build-jib/README.md @@ -16,6 +16,12 @@ steps: working-directory: "." # (Optional) ``` +## Dependencies + +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) +- [actions/upload-artifact@v3](https://github.com/actions/upload-artifact/tree/v3) + ## References ### Inputs diff --git a/docs/actions/java-gradle-build/README.md b/docs/actions/java-gradle-build/README.md index b8d8830d4..5bff29706 100644 --- a/docs/actions/java-gradle-build/README.md +++ b/docs/actions/java-gradle-build/README.md @@ -16,6 +16,12 @@ steps: working-directory: "." # (Optional) ``` +## Dependencies + +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) +- [actions/upload-artifact@v3](https://github.com/actions/upload-artifact/tree/v3) + ## References ### Inputs diff --git a/docs/actions/java-gradle-publish-plugin/README.md b/docs/actions/java-gradle-publish-plugin/README.md index 81b0f77b2..f7e88b259 100644 --- a/docs/actions/java-gradle-publish-plugin/README.md +++ b/docs/actions/java-gradle-publish-plugin/README.md @@ -20,6 +20,11 @@ steps: working-directory: "." # (Optional) ``` +## Dependencies + +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) + ## References ### Inputs diff --git a/docs/actions/java-gradle-publish/README.md b/docs/actions/java-gradle-publish/README.md index ce70c407a..e16247062 100644 --- a/docs/actions/java-gradle-publish/README.md +++ b/docs/actions/java-gradle-publish/README.md @@ -20,6 +20,11 @@ steps: working-directory: "." # (Optional) ``` +## Dependencies + +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) + ## References ### Inputs diff --git a/docs/actions/java-gradle-release-github/README.md b/docs/actions/java-gradle-release-github/README.md index bc5997810..f15108242 100644 --- a/docs/actions/java-gradle-release-github/README.md +++ b/docs/actions/java-gradle-release-github/README.md @@ -17,6 +17,13 @@ steps: working-directory: "." # (Optional) ``` +## Dependencies + +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [actions/download-artifact@v3](https://github.com/actions/download-artifact/tree/v3) +- [bakdata/ci-templates/actions/changelog-generate@1.38.0](https://github.com/bakdata/ci-templates/blob/1.38.0/actions/changelog-generate) +- [softprops/action-gh-release@v1](https://github.com/softprops/action-gh-release/tree/v1) + ## References ### Inputs diff --git a/docs/actions/java-gradle-release/README.md b/docs/actions/java-gradle-release/README.md index 34a37afbb..650238560 100644 --- a/docs/actions/java-gradle-release/README.md +++ b/docs/actions/java-gradle-release/README.md @@ -20,6 +20,12 @@ steps: working-directory: "." # (Optional) ``` +## Dependencies + +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) +- [bakdata/ci-templates/actions/changelog-generate@1.38.0](https://github.com/bakdata/ci-templates/blob/1.38.0/actions/changelog-generate) + ## References ### Inputs diff --git a/docs/actions/java-gradle-setup/README.md b/docs/actions/java-gradle-setup/README.md index 840b5f63e..af84cf2a3 100644 --- a/docs/actions/java-gradle-setup/README.md +++ b/docs/actions/java-gradle-setup/README.md @@ -14,6 +14,11 @@ steps: gradle-version: "wrapper" # (Optional) ``` +## Dependencies + +- [actions/setup-java@v3](https://github.com/actions/setup-java/tree/v3) +- [gradle/gradle-build-action@v2](https://github.com/gradle/gradle-build-action/tree/v2) + ## References ### Inputs diff --git a/docs/actions/java-gradle-test/README.md b/docs/actions/java-gradle-test/README.md index 03754b565..309e8c6e2 100644 --- a/docs/actions/java-gradle-test/README.md +++ b/docs/actions/java-gradle-test/README.md @@ -15,6 +15,12 @@ steps: working-directory: "." # (Optional) ``` +## Dependencies + +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) +- [mikepenz/action-junit-report@v3](https://github.com/mikepenz/action-junit-report/tree/v3) + ## References ### Inputs diff --git a/docs/actions/java-maven-build/README.md b/docs/actions/java-maven-build/README.md index 58c429d4f..e33fbb08a 100644 --- a/docs/actions/java-maven-build/README.md +++ b/docs/actions/java-maven-build/README.md @@ -16,6 +16,11 @@ steps: command: "compile" # (Optional) ``` +## Dependencies + +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-maven-setup@1.33.0](https://github.com/bakdata/ci-templates/blob/1.33.0/actions/java-maven-setup) + ## References ### Inputs diff --git a/docs/actions/java-maven-release/README.md b/docs/actions/java-maven-release/README.md index 925078534..b88497d1c 100644 --- a/docs/actions/java-maven-release/README.md +++ b/docs/actions/java-maven-release/README.md @@ -19,6 +19,11 @@ steps: working-directory: "." # (Optional) ``` +## Dependencies + +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-maven-setup@1.33.0](https://github.com/bakdata/ci-templates/blob/1.33.0/actions/java-maven-setup) + ## References ### Inputs diff --git a/docs/actions/java-maven-setup/README.md b/docs/actions/java-maven-setup/README.md index f5b0761b9..b1002231e 100644 --- a/docs/actions/java-maven-setup/README.md +++ b/docs/actions/java-maven-setup/README.md @@ -14,6 +14,11 @@ steps: java-version: "11" # (Optional) ``` +## Dependencies + +- [actions/setup-java@v3](https://github.com/actions/setup-java/tree/v3) +- [yuzhiyongcn/setup-maven@v1.0.0](https://github.com/yuzhiyongcn/setup-maven/tree/v1.0.0) + ## References ### Inputs diff --git a/docs/actions/java-maven-test/README.md b/docs/actions/java-maven-test/README.md index 3b93769c3..cc3e60027 100644 --- a/docs/actions/java-maven-test/README.md +++ b/docs/actions/java-maven-test/README.md @@ -16,6 +16,11 @@ steps: command: "test" # (Optional) ``` +## Dependencies + +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-maven-setup@1.33.0](https://github.com/bakdata/ci-templates/blob/1.33.0/actions/java-maven-setup) + ## References ### Inputs diff --git a/docs/actions/port-forward/README.md b/docs/actions/port-forward/README.md index 039f13900..3b0c30b7f 100644 --- a/docs/actions/port-forward/README.md +++ b/docs/actions/port-forward/README.md @@ -14,6 +14,10 @@ steps: namespace: infrastructure ``` +## Dependencies + +- [azure/setup-kubectl@v3](https://github.com/azure/setup-kubectl/tree/v3) + ## References ### Inputs diff --git a/docs/actions/python-poetry-bump-version/README.md b/docs/actions/python-poetry-bump-version/README.md index f20389a0c..58c21708f 100644 --- a/docs/actions/python-poetry-bump-version/README.md +++ b/docs/actions/python-poetry-bump-version/README.md @@ -4,26 +4,7 @@ This composite action bumps the Python package version depending on the release ## Dependencies -This action uses another composite action listed below: - -- [python-setup-poetry](https://github.com/bakdata/ci-templates/tree/main/actions/python-setup-poetry) - -## Usage - -```yaml -steps: - # Other steps in your workflow - - name: Bump version - id: bump-version - uses: bakdata/ci-templates/actions/python-poetry-bump-version@main - with: - release-type: ${{ inputs.release-type }} - python-version: ${{ inputs.python-version }} - poetry-version: ${{ inputs.poetry-version }} - - - name: Use bump version output - run: echo Bumped version from ${{ steps.bump-version.outputs.old-version }} to ${{ steps.bump-version.outputs.release-version }} -``` +- [bakdata/ci-templates/actions/python-setup-poetry@v1.5.3](https://github.com/bakdata/ci-templates/blob/v1.5.3/actions/python-setup-poetry) ## References diff --git a/docs/actions/python-poetry-publish-pypi/README.md b/docs/actions/python-poetry-publish-pypi/README.md index cf2d4b36a..e6cc96cd8 100644 --- a/docs/actions/python-poetry-publish-pypi/README.md +++ b/docs/actions/python-poetry-publish-pypi/README.md @@ -19,6 +19,10 @@ steps: working-directory: ${{ inputs.working-directory }} ``` +## Dependencies + +- [bakdata/ci-templates/actions/python-poetry-publish@1.40.4](https://github.com/bakdata/ci-templates/blob/1.40.4/actions/python-poetry-publish) + ## References ### Inputs diff --git a/docs/actions/python-setup-poetry/README.md b/docs/actions/python-setup-poetry/README.md index 1435c88ed..f831d3742 100644 --- a/docs/actions/python-setup-poetry/README.md +++ b/docs/actions/python-setup-poetry/README.md @@ -18,6 +18,10 @@ steps: # Rest of your workflow ``` +## Dependencies + +- [actions/setup-python@v4](https://github.com/actions/setup-python/tree/v4) + ## References ### Inputs diff --git a/docs/actions/setup-credentials/README.md b/docs/actions/setup-credentials/README.md index 83896f4f7..6abfd864f 100644 --- a/docs/actions/setup-credentials/README.md +++ b/docs/actions/setup-credentials/README.md @@ -16,6 +16,11 @@ steps: gcloud-sdk-version: "376.0.0" # optional ``` +## Dependencies + +- [google-github-actions/auth@v2](https://github.com/google-github-actions/auth/tree/v2) +- [google-github-actions/setup-gcloud@v0.6.0](https://github.com/google-github-actions/setup-gcloud/tree/v0.6.0) + ## References ### Inputs diff --git a/docs/actions/tag-and-release/README.md b/docs/actions/tag-and-release/README.md index b20ad6c3c..23151c029 100644 --- a/docs/actions/tag-and-release/README.md +++ b/docs/actions/tag-and-release/README.md @@ -4,24 +4,7 @@ This composite action allows you to create a Git tag and GitHub release. ## Dependencies -This action uses another composite action listed below: - -- [action-gh-release](https://github.com/softprops/action-gh-release) - -## Usage - -```yaml -steps: - - name: Check out repository - uses: bakdata/ci-templates/actions/checkout@1.32.0 - - - name: Tag and release project - uses: bakdata/ci-templates/actions/tag-and-release@main - with: - tag: "1.0.0" - release-title: "This should be the title for the GitHub release" - release-body: "This should be on the text part of the GitHub release" -``` +- [softprops/action-gh-release@v1](https://github.com/softprops/action-gh-release/tree/v1) ## References diff --git a/docs/workflows/bump-version-release/README.md b/docs/workflows/bump-version-release/README.md index 2f70664a3..dfe3c0e4b 100644 --- a/docs/workflows/bump-version-release/README.md +++ b/docs/workflows/bump-version-release/README.md @@ -9,51 +9,8 @@ Moreover, prepare a `github-username`, a `github-email` and a `github-token` to ## Dependencies -This workflow is built from other composite actions listed below: - -- [bump-version](https://github.com/bakdata/ci-templates/tree/main/actions/bump-version) -- [changelog-generate](https://github.com/bakdata/ci-templates/tree/main/actions/changelog-generate) -- [commit-and-push](https://github.com/bakdata/ci-templates/tree/main/actions/commit-and-push) -- [tag-and-release](https://github.com/bakdata/ci-templates/tree/main/actions/tag-and-release) - -## Calling the workflow - -```yaml -name: Release - -on: - workflow_dispatch: - inputs: - release-type: - description: "Scope of the release." - type: choice - required: true - default: patch - options: - - patch - - minor - - major - -jobs: - call-workflow-passing-data: - name: Release - uses: bakdata/ci-templates/.github/workflows/bump-version-release.yaml@main - with: - release-type: "${{ github.event.inputs.release-type }}" - changelog: false # (Optional) Default is true - changelog-config: "./.github/changelog-config.json" # (Optional) - working-directory: "." # (Optional) Default is . - secrets: - github-username: "${{ secrets.GH_USERNAME }}" - github-email: "${{ secrets.GH_EMAIL }}" - github-token: "${{ secrets.GH_TOKEN }}" - - use-output-of-workflow: - runs-on: ubuntu-latest - needs: call-workflow-passing-data - steps: - - run: echo Bumped Version from ${{ needs.call-workflow-passing-data.outputs.old-version }} to ${{ needs.call-workflow-passing-data.outputs.release-version }} -``` +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) ## References diff --git a/docs/workflows/docker-build-and-publish/README.md b/docs/workflows/docker-build-and-publish/README.md index 68d76e03b..cb9e50427 100644 --- a/docs/workflows/docker-build-and-publish/README.md +++ b/docs/workflows/docker-build-and-publish/README.md @@ -8,40 +8,8 @@ This workflow requires a Dockerfile located in the repository. ## Dependencies -This workflow is built from multiple composite actions listed below: - -- [docker-build](https://github.com/bakdata/ci-templates/tree/main/actions/docker-build) -- [docker-publish](https://github.com/bakdata/ci-templates/tree/main/actions/docker-publish) - -## Calling the workflow - -```yaml -name: Docker build and publish - -on: - workflow_dispatch: - -jobs: - call-workflow-passing-data: - name: Build and push Docker image - uses: bakdata/ci-templates/.github/workflows/docker-build-and-publish.yaml@main - with: - # with these settings image would be pushed to my-registry.com/my-namespace/my-image:my-tag - docker-context: "./docker-dir/" - dockerfile-path: "./path/to/my/Dockerfile" - docker-registry: "my-registry.com" - image-namespace: "my-namespace" - image-name: "my-image" - image-tag: "my-tag" - ref: "feat/foo" - retention-days: 2 - image-artifact-name: "my-image-artifact" - working-directory: "." - secrets: - docker-user: "${{ secrets.DOCKER_USER }}" - docker-password: "${{ secrets.DOCKER_PWD }}" - github-token: ${{ secrets.GH_TOKEN }} -``` +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) ## References diff --git a/docs/workflows/helm-gke-deploy/README.md b/docs/workflows/helm-gke-deploy/README.md index b69d8246e..7d6b4a458 100644 --- a/docs/workflows/helm-gke-deploy/README.md +++ b/docs/workflows/helm-gke-deploy/README.md @@ -1,5 +1,10 @@ # Description of helm-gke-deploy reusable Workflow +## Dependencies + +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) + ## References ### Inputs diff --git a/docs/workflows/helm-gke-destroy/README.md b/docs/workflows/helm-gke-destroy/README.md index 3839c4cac..59889751a 100644 --- a/docs/workflows/helm-gke-destroy/README.md +++ b/docs/workflows/helm-gke-destroy/README.md @@ -1,5 +1,10 @@ # Description of helm-gke-destroy reusable Workflow +## Dependencies + +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) + ## References ### Inputs diff --git a/docs/workflows/helm-multi-release/README.md b/docs/workflows/helm-multi-release/README.md index de2c40921..d55086c17 100644 --- a/docs/workflows/helm-multi-release/README.md +++ b/docs/workflows/helm-multi-release/README.md @@ -24,54 +24,8 @@ We upload the newly created artifacts as well as the `index.yaml` file to `gh-pa ## Dependencies -This workflow is built from multiple composite actions listed below: - -- [helm-lint](https://github.com/bakdata/ci-templates/tree/main/actions/helm-lint) -- [commit-and-push](https://github.com/bakdata/ci-templates/tree/main/actions/commit-and-push) - -## Calling the workflow - -### Multi-chart - -```yaml -name: Release multiple Helm Charts -on: - workflow_dispatch: - -jobs: - call-workflow-passing-data: - name: Release & Publish Helm chart - uses: bakdata/ci-templates/.github/workflows/helm-multi-release.yaml@main - with: - charts-path: "./charts" - subdirs: "['subdir1', 'subdir2', 'subdir3']" - gh-pages-branch: gh-pages - secrets: - github-email: "${{ secrets.GH_EMAIL }}" - github-username: "${{ secrets.GH_USERNAME }}" - github-token: "${{ secrets.GH_TOKEN }}" -``` - -### Single chart - -```yaml -name: Release multiple Helm Charts -on: - workflow_dispatch: - -jobs: - call-workflow-passing-data: - name: Release & Publish Helm chart - uses: bakdata/ci-templates/.github/workflows/helm-multi-release.yaml@main - with: - charts-path: "./helm-chart" - subdirs: "['.']" - gh-pages-branch: gh-pages - secrets: - github-email: "${{ secrets.GH_EMAIL }}" - github-username: "${{ secrets.GH_USERNAME }}" - github-token: "${{ secrets.GH_TOKEN }}" -``` +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) ## References diff --git a/docs/workflows/helm-release/README.md b/docs/workflows/helm-release/README.md index 490a33017..a1056be3a 100644 --- a/docs/workflows/helm-release/README.md +++ b/docs/workflows/helm-release/README.md @@ -31,43 +31,8 @@ Currently, it is not possible to download a previously created Pages artifact as ## Dependencies -This workflow is built from multiple composite actions listed below: - -- [helm-lint](https://github.com/bakdata/ci-templates/tree/main/actions/helm-lint) -- [bump-version](https://github.com/bakdata/ci-templates/tree/main/actions/bump-version) -- [helm-package](https://github.com/bakdata/ci-templates/tree/main/actions/helm-package) -- [commit-and-push](https://github.com/bakdata/ci-templates/tree/main/actions/commit-and-push) - -## Calling the workflow - -```yaml -name: Call this reusable workflow - -on: - workflow_dispatch: - inputs: - release-type: - description: "The scope of the release (major, minor or patch)." - default: "patch" - required: false - -jobs: - call-workflow-passing-data: - uses: bakdata/ci-templates/.github/workflows/helm-release.yaml@main - with: - page-url: https://example.github.io/your-repository - release-type: ${{ inputs.release-type }} - ref: "my-awesome-ref" # (Optional) - lint-config-path: "my-lint-config.yaml" # (Optional) - helm-version: "v3.10.1" # (Optional) - charts-dir: charts # (Optional) - skip-download: "false" # (Optional) - artifact-dir: "artifact" # (Optional) - secrets: - github-email: "${{ secrets.GH_EMAIL }}" - github-username: "${{ secrets.GH_USERNAME }}" - github-token: "${{ secrets.GH_TOKEN }}" -``` +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) ## References diff --git a/docs/workflows/java-gradle-base/README.md b/docs/workflows/java-gradle-base/README.md index b9aaec990..cf456e9d0 100644 --- a/docs/workflows/java-gradle-base/README.md +++ b/docs/workflows/java-gradle-base/README.md @@ -9,38 +9,8 @@ file that uses the [Sonar](https://github.com/bakdata/gradle-plugins/tree/master ## Dependencies -This workflow is built from multiple composite actions listed below: - -- [java-gradle-build](https://github.com/bakdata/ci-templates/tree/main/actions/java-gradle-build) -- [java-gradle-test](https://github.com/bakdata/ci-templates/tree/main/actions/java-gradle-test) -- [java-gradle-assess-code-quality](https://github.com/bakdata/ci-templates/tree/main/actions/java-gradle-assess-code-quality) - -## Calling the workflow - -```yaml -name: Call this reusable workflow - -on: - push: - branches: [main] - -jobs: - call-workflow-passing-data: - name: Java Gradle Docker - uses: bakdata/ci-templates/.github/workflows/java-gradle-base.yaml@main - with: - java-distribution: "microsoft" # (Optional) Default is microsoft - java-version: "11" # (Optional) Default is 11 - gradle-version: "wrapper" # (Optional) Default is wrapper - gradle-cache: false # (Optional) Default is true - working-directory: "." # (Optional) Default is . - secrets: - sonar-token: ${{ secrets.SONARCLOUD_TOKEN }} - sonar-organization: ${{ secrets.SONARCLOUD_ORGANIZATION }} - signing-secret-key-ring: ${{ secrets.SIGNING_SECRET_KEY_RING }} - signing-key-id: ${{ secrets.SIGNING_KEY_ID }} - signing-password: ${{ secrets.SIGNING_PASSWORD }} -``` +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) ## References diff --git a/docs/workflows/java-gradle-docker/README.md b/docs/workflows/java-gradle-docker/README.md index e0931fd9c..f6f0c21fe 100644 --- a/docs/workflows/java-gradle-docker/README.md +++ b/docs/workflows/java-gradle-docker/README.md @@ -10,47 +10,8 @@ file that uses the [Sonar](https://github.com/bakdata/gradle-plugins/tree/master ## Dependencies -This workflow is built from multiple composite actions and workflows listed below: - -- [java-gradle-base](https://github.com/bakdata/ci-templates/tree/main/.github/workflows/java-gradle-base.yaml) -- [java-gradle-build-jib](https://github.com/bakdata/ci-templates/tree/main/actions/java-gradle-build-jib) -- [java-gradle-publish](https://github.com/bakdata/ci-templates/tree/main/actions/java-gradle-publish) -- [docker-publish](https://github.com/bakdata/ci-templates/tree/main/actions/docker-publish) -- [java-gradle-release-github](https://github.com/bakdata/ci-templates/tree/main/actions/java-gradle-release-github) - -## Calling the workflow - -```yaml -name: Call this reusable workflow - -on: - push: - branches: [main] - -jobs: - call-workflow-passing-data: - name: Java Gradle Docker - uses: bakdata/ci-templates/.github/workflows/java-gradle-docker.yaml@main - with: - docker-publisher: "my-publisher" # (Required) - java-distribution: "microsoft" # (Optional) Default is microsoft - java-version: "11" # (Optional) Default is 11 - gradle-version: "wrapper" # (Optional) Default is wrapper - gradle-cache: false # (Optional) Default is true - working-directory: "." # (Optional) Default is . - secrets: - sonar-token: ${{ secrets.SONARCLOUD_TOKEN }} - sonar-organization: ${{ secrets.SONARCLOUD_ORGANIZATION }} - signing-secret-key-ring: ${{ secrets.SIGNING_SECRET_KEY_RING }} - signing-key-id: ${{ secrets.SIGNING_KEY_ID }} - signing-password: ${{ secrets.SIGNING_PASSWORD }} - ossrh-username: ${{ secrets.OSSHR_USERNAME }} - ossrh-password: ${{ secrets.OSSHR_PASSWORD }} - docker-username: ${{ secrets.DOCKERHUB_USERNAME }} - docker-password: ${{ secrets.DOCKERHUB_TOKEN }} - github-username: ${{ secrets.GH_USERNAME }} - github-token: ${{ secrets.GH_TOKEN }} -``` +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) ## References diff --git a/docs/workflows/java-gradle-library/README.md b/docs/workflows/java-gradle-library/README.md index 1174eccac..ecce60312 100644 --- a/docs/workflows/java-gradle-library/README.md +++ b/docs/workflows/java-gradle-library/README.md @@ -10,42 +10,8 @@ file that uses the [Sonar](https://github.com/bakdata/gradle-plugins/tree/master ## Dependencies -This workflow is built from multiple composite actions and workflows listed below: - -- [java-gradle-base](https://github.com/bakdata/ci-templates/tree/main/.github/workflows/java-gradle-base.yaml) -- [java-gradle-publish](https://github.com/bakdata/ci-templates/tree/main/actions/java-gradle-publish) -- [java-gradle-release-github](https://github.com/bakdata/ci-templates/tree/main/actions/java-gradle-release-github) - -## Calling the workflow - -```yaml -name: Call this reusable workflow - -on: - push: - branches: [main] - -jobs: - call-workflow-passing-data: - name: Java Gradle Library - uses: bakdata/ci-templates/.github/workflows/java-gradle-library.yaml@main - with: - java-distribution: "microsoft" # (Optional) Default is microsoft - java-version: "11" # (Optional) Default is 11 - gradle-version: "wrapper" # (Optional) Default is wrapper - gradle-cache: false # (Optional) Default is true - working-directory: "." # (Optional) Default is . - secrets: - sonar-token: ${{ secrets.SONARCLOUD_TOKEN }} - sonar-organization: ${{ secrets.SONARCLOUD_ORGANIZATION }} - signing-secret-key-ring: ${{ secrets.SIGNING_SECRET_KEY_RING }} - signing-key-id: ${{ secrets.SIGNING_KEY_ID }} - signing-password: ${{ secrets.SIGNING_PASSWORD }} - ossrh-username: ${{ secrets.OSSHR_USERNAME }} - ossrh-password: ${{ secrets.OSSHR_PASSWORD }} - github-username: ${{ secrets.GH_USERNAME }} - github-token: ${{ secrets.GH_TOKEN }} -``` +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) ## References diff --git a/docs/workflows/java-gradle-plugin/README.md b/docs/workflows/java-gradle-plugin/README.md index cab0ac399..032f0ba87 100644 --- a/docs/workflows/java-gradle-plugin/README.md +++ b/docs/workflows/java-gradle-plugin/README.md @@ -11,45 +11,8 @@ and Gradle Plugin Portal. ## Dependencies -This workflow is built from multiple composite actions and workflows listed below: - -- [java-gradle-base](https://github.com/bakdata/ci-templates/tree/main/.github/workflows/java-gradle-base.yaml) -- [java-gradle-publish](https://github.com/bakdata/ci-templates/tree/main/actions/java-gradle-publish) -- [java-gradle-publish-plugin](https://github.com/bakdata/ci-templates/tree/main/actions/java-gradle-publish-plugin) -- [java-gradle-release-github](https://github.com/bakdata/ci-templates/tree/main/actions/java-gradle-release-github) - -## Calling the workflow - -```yaml -name: Call this reusable workflow - -on: - push: - branches: [main] - -jobs: - call-workflow-passing-data: - name: Java Gradle Library - uses: bakdata/ci-templates/.github/workflows/java-gradle-pluglin.yaml@main - with: - java-distribution: "microsoft" # (Optional) Default is microsoft - java-version: "11" # (Optional) Default is 11 - gradle-version: "wrapper" # (Optional) Default is wrapper - gradle-cache: false # (Optional) Default is true - working-directory: "." # (Optional) Default is . - secrets: - sonar-token: ${{ secrets.SONARCLOUD_TOKEN }} - sonar-organization: ${{ secrets.SONARCLOUD_ORGANIZATION }} - signing-secret-key-ring: ${{ secrets.SIGNING_SECRET_KEY_RING }} - signing-key-id: ${{ secrets.SIGNING_KEY_ID }} - signing-password: ${{ secrets.SIGNING_PASSWORD }} - ossrh-username: ${{ secrets.OSSHR_USERNAME }} - ossrh-password: ${{ secrets.OSSHR_PASSWORD }} - gradle-publish-key: ${{ secrets.GRADLE_PUBLISH_KEY }} - gradle-publish-secret: ${{ secrets.GRADLE_PUBLISH_SECRET }} - github-username: ${{ secrets.GH_USERNAME }} - github-token: ${{ secrets.GH_TOKEN }} -``` +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) ## References diff --git a/docs/workflows/java-gradle-release/README.md b/docs/workflows/java-gradle-release/README.md index 9f3866fb9..527aedf2f 100644 --- a/docs/workflows/java-gradle-release/README.md +++ b/docs/workflows/java-gradle-release/README.md @@ -10,45 +10,8 @@ file that uses the [Researchgate Release](https://plugins.gradle.org/plugin/net. ## Dependencies -This workflow is built from another composite action listed below: - -- [java-gradle-setup](https://github.com/bakdata/ci-templates/tree/main/actions/java-gradle-setup) - -## Calling the workflow - -```yaml -name: Release - -on: - workflow_dispatch: - inputs: - release-type: - description: "The scope of the release (major, minor or patch)." - default: "patch" - required: false - -jobs: - call-workflow-passing-data: - name: Java Gradle Release - uses: bakdata/ci-templates/.github/workflows/java-gradle-release.yaml@main - with: - release-type: "${{ github.event.inputs.release-type }}" - java-distribution: "microsoft" # (Optional) Default is microsoft - java-version: "11" # (Optional) Default is 11 - gradle-version: "wrapper" # (Optional) Default is wrapper - gradle-cache: false # (Optional) Default is true - working-directory: "." # (Optional) Default is . - secrets: - github-username: "${{ secrets.GH_USERNAME }}" - github-email: "${{ secrets.GH_EMAIL }}" - github-token: "${{ secrets.GH_TOKEN }}" - - use-output-of-workflow: - runs-on: ubuntu-latest - needs: call-workflow-passing-data - steps: - - run: echo Bumped Version from ${{ needs.call-workflow-passing-data.outputs.old-version }} to ${{ needs.call-workflow-passing-data.outputs.release-version }} -``` +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) ## References diff --git a/docs/workflows/kustomize-gke-deploy/README.md b/docs/workflows/kustomize-gke-deploy/README.md index 791d09955..4b417b909 100644 --- a/docs/workflows/kustomize-gke-deploy/README.md +++ b/docs/workflows/kustomize-gke-deploy/README.md @@ -4,43 +4,8 @@ This workflow will deploy to GKE using a Kustomize root directory. ## Dependencies -This workflow is built from multiple composite actions listed below: - -- [helm-setup](https://github.com/bakdata/ci-templates/tree/main/actions/helm-setup) -- [kustomize-gke-deploy](https://github.com/bakdata/ci-templates/tree/main/actions/kustomize-gke-deploy) - -## Calling the workflow - -```yaml -name: Call this reusable workflow - -on: - workflow_dispatch: - inputs: - kustomization-path: - description: "Path to the root directory of the kustomization" - default: "kustomization-path" - required: false - timeout: - description: "Time out(in seconds) for CustomResourceDefinitions" - default: "60" - required: false - -jobs: - call-workflow-passing-data: - uses: bakdata/ci-templates/.github/workflows/kustomize-gke-deploy.yaml@main - with: - kustomization-path: ${{ inputs.kustomization-path }} - timeout: ${{ inputs.timeout }} #optional - gcloud-sdk-version: "376.0.0" #optional - kubectl-version: "v1.23.0" #optional - helm-version: "v3.8.1" - secrets: - gke-service-account: ${{ secrets.GKE_DEV_SERVICE_ACCOUNT }} - gke-project: ${{ secrets.GKE_DEV_PROJECT }} - gke-region: ${{ secrets.GKE_DEV_REGION }} - gke-cluster: ${{ secrets.GKE_DEV_CLUSTER }} -``` +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) ## References diff --git a/docs/workflows/kustomize-gke-destroy/README.md b/docs/workflows/kustomize-gke-destroy/README.md index a8a7fd2fe..c26dcb5d0 100644 --- a/docs/workflows/kustomize-gke-destroy/README.md +++ b/docs/workflows/kustomize-gke-destroy/README.md @@ -4,42 +4,8 @@ This workflow will uninstall deployments using Kustomize. ## Dependencies -This workflow is built from multiple composite actions listed below: - -- [helm-setup](https://github.com/bakdata/ci-templates/tree/main/actions/helm-setup) -- [kustomize-gke-destroy](https://github.com/bakdata/ci-templates/tree/main/actions/kustomize-gke-destroy) - -## Calling the workflow - -```yaml -name: Call this reusable workflow - -on: - workflow_dispatch: - inputs: - kustomization-path: - description: "Path to the root directory of the kustomization" - default: "kustomization-path" - required: false - timeout: - description: "Time out(in seconds) for CustomResourceDefinitions" - default: "60" - required: false - -jobs: - call-workflow-passing-data: - uses: bakdata/ci-templates/.github/workflows/kustomize-gke-destroy.yaml@main - with: - kustomization-path: ${{ inputs.kustomization-path }} - gcloud-sdk-version: "376.0.0" #optional - kubectl-version: "v1.23.0" #optional - helm-version: "v3.8.1" #optional - secrets: - gke-service-account: ${{ secrets.GKE_DEV_SERVICE_ACCOUNT }} - gke-project: ${{ secrets.GKE_DEV_PROJECT }} - gke-region: ${{ secrets.GKE_DEV_REGION }} - gke-cluster: ${{ secrets.GKE_DEV_CLUSTER }} -``` +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) ## References diff --git a/docs/workflows/python-poetry-publish-pypi/README.md b/docs/workflows/python-poetry-publish-pypi/README.md index 839066601..e93bb5d34 100644 --- a/docs/workflows/python-poetry-publish-pypi/README.md +++ b/docs/workflows/python-poetry-publish-pypi/README.md @@ -11,32 +11,8 @@ Your Python project needs to be set up with Poetry and contain a `pyproject.toml ## Dependencies -This workflow is built from multiple composite actions listed below: - -- [python-setup-poetry](https://github.com/bakdata/ci-templates/tree/main/actions/python-setup-poetry) -- [python-poetry-publish-pypi](https://github.com/bakdata/ci-templates/tree/main/actions/python-poetry-publish-pypi) - -## Calling the workflow - -```yaml -name: Publish - -on: - push: - tags: - - "*" - -jobs: - call-workflow-passing-data: - uses: bakdata/ci-templates/.github/workflows/python-poetry-publish-pypi.yaml@main - with: - publish-to-test: false # (Optional) By default the packages are published to TestPyPI. In this case the packages are published to PyPI - python-version: 3.8 # (Optional) Default value is 3.10. In this case Poetry is installed with Python 3.8 - poetry-version: "1.1.11" # (Optional) Default value is 1.5.1. In this case Poetry version 1.1.11 is installed - working-directory: "./my-awesome-python-project" # (Optional) Default value is the root directory of your repository. In this case all the files to the given path are published - secrets: - pypi-token: ${{ secrets.PYPI_TOKEN }} -``` +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) ## References diff --git a/docs/workflows/python-poetry-publish-snapshot/README.md b/docs/workflows/python-poetry-publish-snapshot/README.md index c4a9ba2b7..432fb9ed0 100644 --- a/docs/workflows/python-poetry-publish-snapshot/README.md +++ b/docs/workflows/python-poetry-publish-snapshot/README.md @@ -8,29 +8,8 @@ Your Python project needs to be set up with Poetry and contain a `pyproject.toml ## Dependencies -This workflow is built from multiple composite actions listed below: - -- [python-poetry-bump-version](https://github.com/bakdata/ci-templates/tree/main/actions/python-poetry-bump-version) -- [python-poetry-publish-pypi](https://github.com/bakdata/ci-templates/tree/main/actions/python-poetry-publish-pypi) - -## Calling the workflow - -```yaml -name: Publish snapshot - -on: - push: - -jobs: - call-workflow-passing-data: - uses: bakdata/ci-templates/.github/workflows/python-poetry-publish-snapshot.yaml@main - with: - python-version: 3.8 # (Optional) Default value is 3.10. In this case Poetry is installed with Python 3.8 - poetry-version: "1.1.11" # (Optional) Default value is 1.5.1. In this case Poetry version 1.1.11 is installed - working-directory: "./my-awesome-python-project" # (Optional) Default value is the root directory of your repository. In this case all the files to the given path are published - secrets: - pypi-token: ${{ secrets.TEST_PYPI_TOKEN }} -``` +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) ## References diff --git a/docs/workflows/python-poetry-release/README.md b/docs/workflows/python-poetry-release/README.md index 730c76cba..07aea1829 100644 --- a/docs/workflows/python-poetry-release/README.md +++ b/docs/workflows/python-poetry-release/README.md @@ -14,44 +14,8 @@ is a protection rule in place. ## Dependencies -This workflow is built from multiple composite actions listed below: - -- [python-poetry-bump-version](https://github.com/bakdata/ci-templates/tree/main/actions/python-poetry-bump-version) -- [tag-and-release](https://github.com/bakdata/ci-templates/tree/main/actions/tag-and-release) -- [commit-and-push](https://github.com/bakdata/ci-templates/tree/main/actions/commit-and-push) -- [changelog-generate](https://github.com/bakdata/ci-templates/tree/main/actions/changelog-generate) - -## Calling the workflow - -```yaml -name: Call this reusable workflow - -on: - push: - branches: [main] - -jobs: - call-workflow-passing-data: - uses: bakdata/ci-templates/.github/workflows/python-poetry-release.yaml@main - with: - release-type: patch # (Required) See more values at: https://python-poetry.org/docs/cli/#version - ref: my-awesome-ref # (Optional) if not set the ${{ github.event.repository.default_branch }} will fill the value. In this case the changes will be pushed to my-awesome-ref - python-version: 3.8 # (Optional) Default value is 3.10. In this case Poetry is installed with Python 3.8 - poetry-version: "1.1.11" # (Optional) Default value is 1.5.1. In this case Poetry version 1.1.11 is installed - working-directory: "./my-awesome-python-project" # (Optional) Default value is the root directory of your repository. In this case all the files to the given path are published - changelog: false # (Optional) Default to true. - changelog-config: ./my-changelog-config.json # (Optional) Set only if changelog is set to true. More information about it here https://github.com/bakdata/ci-templates/tree/main/actions/changelog-generate - secrets: - github-email: ${{ secrets.GH_EMAIL }} - github-username: ${{ secrets.GH_USERNAME }} - github-token: ${{ secrets.GH_TOKEN }} - - use-output-of-workflow: - runs-on: ubuntu-latest - needs: call-workflow-passing-data - steps: - - run: echo Bumped Version from ${{ needs.call-workflow-passing-data.outputs.old-version }} to ${{ needs.call-workflow-passing-data.outputs.release-version }} -``` +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) ## References diff --git a/docs/workflows/release-tag-versions/README.md b/docs/workflows/release-tag-versions/README.md index cac95c04a..03cbcdfa5 100644 --- a/docs/workflows/release-tag-versions/README.md +++ b/docs/workflows/release-tag-versions/README.md @@ -25,40 +25,8 @@ replace = ## Dependencies -This workflow is built from multiple composite actions listed below: - -- [bump-version](https://github.com/bakdata/ci-templates/tree/main/actions/bump-version) -- [commit-and-push](https://github.com/bakdata/ci-templates/tree/main/actions/commit-and-push) - -## Calling the workflow - -```yaml -name: Release multiple Helm Charts -on: - workflow_dispatch: - inputs: - release-type: - description: "Scope of the release (major, minor or patch)." - required: true - type: string - next-dev-release-type: - description: "Scope of the next release (minor or patch) for developers" - required: true - type: string -jobs: - call-workflow-passing-data: - name: Release & Publish Helm chart - uses: bakdata/ci-templates/.github/workflows/release-tag-versions.yaml@main - with: - version-configs-dir: "." - release-type: "${{ inputs.release-type }}" - next-dev-release-type: "${{ inputs.next-dev-release-type }}" - next-dev-release-suffix: "SNAPSHOT" - secrets: - github-email: "${{ secrets.GH_EMAIL }}" - github-username: "${{ secrets.GH_USERNAME }}" - github-token: "${{ secrets.GH_TOKEN }}" -``` +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) ## References diff --git a/docs/workflows/test-python-setup-poetry/README.md b/docs/workflows/test-python-setup-poetry/README.md index fbf21f5e7..de238194a 100644 --- a/docs/workflows/test-python-setup-poetry/README.md +++ b/docs/workflows/test-python-setup-poetry/README.md @@ -1,5 +1,10 @@ # Description of test-python-setup-poetry reusable Workflow +## Dependencies + +- [bakdata/ci-templates/actions/checkout@1.32.0](https://github.com/bakdata/ci-templates/blob/1.32.0/actions/checkout) +- [bakdata/ci-templates/actions/java-gradle-setup@v1.16.0](https://github.com/bakdata/ci-templates/blob/v1.16.0/actions/java-gradle-setup) + ## References ### Inputs