From 58fc61844355ae73ac373c0a549862328cd72bc2 Mon Sep 17 00:00:00 2001 From: Kristopher Kubicki <478212+KristopherKubicki@users.noreply.github.com> Date: Fri, 20 Jun 2025 11:09:15 -0500 Subject: [PATCH 1/7] Run CI on staging and main --- .github/workflows/ci.yml | 38 ++++++++++++++++++++++++++++++++++++++ README.md | 6 ++++++ dummy.py | 3 +++ profile/README.md | 4 ++++ requirements.txt | 2 ++ tests/test_dummy.py | 4 ++++ 6 files changed, 57 insertions(+) create mode 100644 .github/workflows/ci.yml create mode 100644 README.md create mode 100644 dummy.py create mode 100644 requirements.txt create mode 100644 tests/test_dummy.py diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml new file mode 100644 index 0000000..8c5442a --- /dev/null +++ b/.github/workflows/ci.yml @@ -0,0 +1,38 @@ +name: CI + +on: + push: + branches: + - main + - staging + pull_request: + branches: + - main + - staging + +jobs: + build: + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Set up Python + uses: actions/setup-python@v5 + with: + python-version: '3.11' + + - name: Install dependencies + run: | + python -m pip install --upgrade pip + pip install -r requirements.txt + + - name: Run tests + run: pytest --cov=. --cov-report xml + + - name: Upload coverage to Codecov + uses: codecov/codecov-action@v4 + with: + token: ${{ secrets.CODECOV_TOKEN }} + files: ./coverage.xml + fail_ci_if_error: true diff --git a/README.md b/README.md new file mode 100644 index 0000000..ebd64dc --- /dev/null +++ b/README.md @@ -0,0 +1,6 @@ +# OpenBrand + +![CI](https://github.com/OpenBrandHQ/GapIntelligence/actions/workflows/ci.yml/badge.svg) +[![codecov](https://codecov.io/gh/OpenBrandHQ/GapIntelligence/branch/main/graph/badge.svg)](https://codecov.io/gh/OpenBrandHQ/GapIntelligence) + +This repository contains configuration files and documentation used by OpenBrand. diff --git a/dummy.py b/dummy.py new file mode 100644 index 0000000..ad81f48 --- /dev/null +++ b/dummy.py @@ -0,0 +1,3 @@ +def add(a, b): + """Return the sum of a and b.""" + return a + b diff --git a/profile/README.md b/profile/README.md index 7c82d21..b904277 100644 --- a/profile/README.md +++ b/profile/README.md @@ -3,6 +3,10 @@ Welcome to the OpenBrand GitHub repository. OpenBrand was formed through the integration of industry-leading companies: Gap Intelligence, Deep.ad, Traqline, and Competitive Promotion Report. We are committed to bringing clarity to the market through superior data analytics, web crawling technology, and LLM-driven insights. +![CI](https://github.com/OpenBrandHQ/GapIntelligence/actions/workflows/ci.yml/badge.svg) +[![codecov](https://codecov.io/gh/OpenBrandHQ/GapIntelligence/branch/main/graph/badge.svg)](https://codecov.io/gh/OpenBrandHQ/GapIntelligence) + + **Official Website:** [openbrand.com](https://openbrand.com) ## About OpenBrand diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..9955dec --- /dev/null +++ b/requirements.txt @@ -0,0 +1,2 @@ +pytest +pytest-cov diff --git a/tests/test_dummy.py b/tests/test_dummy.py new file mode 100644 index 0000000..386b5c3 --- /dev/null +++ b/tests/test_dummy.py @@ -0,0 +1,4 @@ +from dummy import add + +def test_add(): + assert add(1, 2) == 3 From e971058abfd3239af83111416b8cff1a35f412f5 Mon Sep 17 00:00:00 2001 From: Kristopher Kubicki <478212+KristopherKubicki@users.noreply.github.com> Date: Sat, 21 Jun 2025 18:34:14 -0500 Subject: [PATCH 2/7] Create visibility.json Signed-off-by: Kristopher Kubicki <478212+KristopherKubicki@users.noreply.github.com> --- visibility.json | 6 ++++++ 1 file changed, 6 insertions(+) create mode 100644 visibility.json diff --git a/visibility.json b/visibility.json new file mode 100644 index 0000000..1c5247f --- /dev/null +++ b/visibility.json @@ -0,0 +1,6 @@ +{ + "schemaVersion": 1, + "label": "repo", + "message": "public", + "color": "brightgreen" +} From f52c75a7098f0843049178f8646571df7de083b0 Mon Sep 17 00:00:00 2001 From: Kristopher Kubicki <478212+KristopherKubicki@users.noreply.github.com> Date: Sun, 22 Jun 2025 09:51:15 -0500 Subject: [PATCH 3/7] Correct badge organization --- .github/workflows/ci.yml | 2 +- README.md | 4 ++-- profile/README.md | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 8c5442a..479fdd9 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -28,7 +28,7 @@ jobs: pip install -r requirements.txt - name: Run tests - run: pytest --cov=. --cov-report xml + run: python -m pytest --cov=. --cov-report xml - name: Upload coverage to Codecov uses: codecov/codecov-action@v4 diff --git a/README.md b/README.md index ebd64dc..820e4f5 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # OpenBrand -![CI](https://github.com/OpenBrandHQ/GapIntelligence/actions/workflows/ci.yml/badge.svg) -[![codecov](https://codecov.io/gh/OpenBrandHQ/GapIntelligence/branch/main/graph/badge.svg)](https://codecov.io/gh/OpenBrandHQ/GapIntelligence) +![CI](https://github.com/GapIntelligence/.github/actions/workflows/ci.yml/badge.svg) +[![codecov](https://codecov.io/gh/GapIntelligence/.github/branch/main/graph/badge.svg)](https://codecov.io/gh/GapIntelligence/.github) This repository contains configuration files and documentation used by OpenBrand. diff --git a/profile/README.md b/profile/README.md index b904277..ec72684 100644 --- a/profile/README.md +++ b/profile/README.md @@ -3,8 +3,8 @@ Welcome to the OpenBrand GitHub repository. OpenBrand was formed through the integration of industry-leading companies: Gap Intelligence, Deep.ad, Traqline, and Competitive Promotion Report. We are committed to bringing clarity to the market through superior data analytics, web crawling technology, and LLM-driven insights. -![CI](https://github.com/OpenBrandHQ/GapIntelligence/actions/workflows/ci.yml/badge.svg) -[![codecov](https://codecov.io/gh/OpenBrandHQ/GapIntelligence/branch/main/graph/badge.svg)](https://codecov.io/gh/OpenBrandHQ/GapIntelligence) +![CI](https://github.com/GapIntelligence/.github/actions/workflows/ci.yml/badge.svg) +[![codecov](https://codecov.io/gh/GapIntelligence/.github/branch/main/graph/badge.svg)](https://codecov.io/gh/GapIntelligence/.github) **Official Website:** [openbrand.com](https://openbrand.com) From 611b0bfa196c8bb1bb56e5c1c33d0649904fdd3b Mon Sep 17 00:00:00 2001 From: Kristopher Kubicki <478212+KristopherKubicki@users.noreply.github.com> Date: Sun, 22 Jun 2025 09:55:12 -0500 Subject: [PATCH 4/7] Update README.md Signed-off-by: Kristopher Kubicki <478212+KristopherKubicki@users.noreply.github.com> --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 820e4f5..022efe6 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # OpenBrand ![CI](https://github.com/GapIntelligence/.github/actions/workflows/ci.yml/badge.svg) -[![codecov](https://codecov.io/gh/GapIntelligence/.github/branch/main/graph/badge.svg)](https://codecov.io/gh/GapIntelligence/.github) +[![codecov](https://codecov.io/gh/GapIntelligence/.github/graph/badge.svg?token=GQXX40CMBF)](https://codecov.io/gh/GapIntelligence/.github) This repository contains configuration files and documentation used by OpenBrand. From 694f4420e8823b4485dccac81cd6ace7496d5e3c Mon Sep 17 00:00:00 2001 From: Kristopher Kubicki <478212+KristopherKubicki@users.noreply.github.com> Date: Sun, 22 Jun 2025 11:41:29 -0500 Subject: [PATCH 5/7] Replace dummy module with mkdocs test --- README.md | 13 +++++++++++++ dummy.py | 3 --- mkdocs.yml | 5 +++++ profile/README.md | 2 ++ requirements.txt | 1 + tests/test_dummy.py | 4 ---- tests/test_mkdocs.py | 15 +++++++++++++++ 7 files changed, 36 insertions(+), 7 deletions(-) delete mode 100644 dummy.py create mode 100644 mkdocs.yml delete mode 100644 tests/test_dummy.py create mode 100644 tests/test_mkdocs.py diff --git a/README.md b/README.md index 820e4f5..5e647d1 100644 --- a/README.md +++ b/README.md @@ -4,3 +4,16 @@ [![codecov](https://codecov.io/gh/GapIntelligence/.github/branch/main/graph/badge.svg)](https://codecov.io/gh/GapIntelligence/.github) This repository contains configuration files and documentation used by OpenBrand. + +## Documentation + +For an overview of the organization, visit the [profile README](profile/README.md). + +## Development + +This repository uses [MkDocs](https://www.mkdocs.org/) for documentation. +Run the test suite (which also builds the site) with: + +```bash +python -m pytest -q +``` diff --git a/dummy.py b/dummy.py deleted file mode 100644 index ad81f48..0000000 --- a/dummy.py +++ /dev/null @@ -1,3 +0,0 @@ -def add(a, b): - """Return the sum of a and b.""" - return a + b diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..79056fb --- /dev/null +++ b/mkdocs.yml @@ -0,0 +1,5 @@ +site_name: OpenBrand Docs +nav: + - Home: README.md + - Profile: profile/README.md +docs_dir: . diff --git a/profile/README.md b/profile/README.md index ec72684..2c5d7e4 100644 --- a/profile/README.md +++ b/profile/README.md @@ -59,4 +59,6 @@ To get started with development, please ensure you have access to the necessary --- +For repository configuration details, see the [main README](../README.md). + Thank you for contributing to OpenBrand's continued success! diff --git a/requirements.txt b/requirements.txt index 9955dec..a8f1632 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,2 +1,3 @@ pytest pytest-cov +mkdocs diff --git a/tests/test_dummy.py b/tests/test_dummy.py deleted file mode 100644 index 386b5c3..0000000 --- a/tests/test_dummy.py +++ /dev/null @@ -1,4 +0,0 @@ -from dummy import add - -def test_add(): - assert add(1, 2) == 3 diff --git a/tests/test_mkdocs.py b/tests/test_mkdocs.py new file mode 100644 index 0000000..eff575a --- /dev/null +++ b/tests/test_mkdocs.py @@ -0,0 +1,15 @@ +import subprocess +from pathlib import Path + + +def test_mkdocs_build(tmp_path: Path) -> None: + """Ensure the mkdocs site builds successfully.""" + site_dir = tmp_path / "site" + result = subprocess.run([ + "mkdocs", + "build", + "--site-dir", + str(site_dir), + ], capture_output=True, text=True) + assert result.returncode == 0, result.stderr + assert site_dir.exists() From 210fda4f22e81b59107b92aebc2b1cf08747ded6 Mon Sep 17 00:00:00 2001 From: Kristopher Kubicki <478212+KristopherKubicki@users.noreply.github.com> Date: Sun, 22 Jun 2025 11:58:18 -0500 Subject: [PATCH 6/7] Fix MkDocs configuration --- README.md | 1 + docs/index.md | 7 +++++++ docs/profile.md | 3 +++ mkdocs.yml | 6 +++--- 4 files changed, 14 insertions(+), 3 deletions(-) create mode 100644 docs/index.md create mode 100644 docs/profile.md diff --git a/README.md b/README.md index 5e647d1..ce1ee24 100644 --- a/README.md +++ b/README.md @@ -8,6 +8,7 @@ This repository contains configuration files and documentation used by OpenBrand ## Documentation For an overview of the organization, visit the [profile README](profile/README.md). +The MkDocs site is built from the files in the [`docs/`](docs/) directory. ## Development diff --git a/docs/index.md b/docs/index.md new file mode 100644 index 0000000..51e2b23 --- /dev/null +++ b/docs/index.md @@ -0,0 +1,7 @@ +# OpenBrand Documentation + +This site contains documentation about the OpenBrand organization. + +For repository details, see the [main README](../README.md). + +Learn more about our organization on the [profile page](profile.md). diff --git a/docs/profile.md b/docs/profile.md new file mode 100644 index 0000000..0722531 --- /dev/null +++ b/docs/profile.md @@ -0,0 +1,3 @@ +# OpenBrand Profile + +This page mirrors the information in [profile/README.md](../profile/README.md). diff --git a/mkdocs.yml b/mkdocs.yml index 79056fb..6de3a16 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,5 +1,5 @@ site_name: OpenBrand Docs nav: - - Home: README.md - - Profile: profile/README.md -docs_dir: . + - Home: index.md + - Profile: profile.md +docs_dir: docs From 276326c0a522f60572ab2b922da5d017a5a79d8d Mon Sep 17 00:00:00 2001 From: Kristopher Kubicki <478212+KristopherKubicki@users.noreply.github.com> Date: Sun, 22 Jun 2025 12:03:22 -0500 Subject: [PATCH 7/7] Update README.md Signed-off-by: Kristopher Kubicki <478212+KristopherKubicki@users.noreply.github.com> --- profile/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/profile/README.md b/profile/README.md index 2c5d7e4..0454e9c 100644 --- a/profile/README.md +++ b/profile/README.md @@ -4,7 +4,7 @@ Welcome to the OpenBrand GitHub repository. OpenBrand was formed through the integration of industry-leading companies: Gap Intelligence, Deep.ad, Traqline, and Competitive Promotion Report. We are committed to bringing clarity to the market through superior data analytics, web crawling technology, and LLM-driven insights. ![CI](https://github.com/GapIntelligence/.github/actions/workflows/ci.yml/badge.svg) -[![codecov](https://codecov.io/gh/GapIntelligence/.github/branch/main/graph/badge.svg)](https://codecov.io/gh/GapIntelligence/.github) +[![codecov](https://codecov.io/gh/GapIntelligence/.github/graph/badge.svg?token=GQXX40CMBF)](https://codecov.io/gh/GapIntelligence/.github) **Official Website:** [openbrand.com](https://openbrand.com)