diff --git a/.github/workflows/rebase-dev.yaml b/.github/workflows/rebase-dev.yaml index d791b30..e430f5d 100644 --- a/.github/workflows/rebase-dev.yaml +++ b/.github/workflows/rebase-dev.yaml @@ -6,6 +6,8 @@ jobs: rebase: name: Rebase runs-on: ubuntu-latest + permissions: + contents: write # Allows pushing changes to the repository steps: - name: Checkout Repository uses: actions/checkout@v3 diff --git a/.gitignore b/.gitignore index f4ababf..2278897 100644 --- a/.gitignore +++ b/.gitignore @@ -150,3 +150,4 @@ auth.toml # Exclude all RST files appart from index.rst *.rst !index.rst +!examples.rst diff --git a/CHANGELOG.md b/CHANGELOG.md index f83b5fc..5243e3e 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,27 @@ # CHANGELOG +## v0.2.2-rc.1 (2024-11-25) + +### Bug Fixes + +- Add write permissions for repository changes + ([`45aea58`](https://github.com/sachahu1/Github-Search-Engine/commit/45aea585a02263669d690bbfda72f4369541a2a0)) + +Added permissions to allow pushing changes to the repository. + +- Add in-memory storage option to GithubSearchEngine + ([`7a83938`](https://github.com/sachahu1/Github-Search-Engine/commit/7a83938848c324f6228180239cf7e06690ea5ed2)) + +Initialize GithubSearchEngine with an optional in-memory storage location. + +- Add examples.rst, update documentation URLs + ([`a2adc30`](https://github.com/sachahu1/Github-Search-Engine/commit/a2adc3052e960203db3fed64ab4ae2debdc10c5d)) + +Added examples.rst for code examples. Updated documentation URLs to use correct capitalization and + domain. + + ## v0.2.1 (2024-11-25) diff --git a/README.md b/README.md index 84c639f..f78d2e9 100644 --- a/README.md +++ b/README.md @@ -24,7 +24,7 @@ github_search_engine index --db_path=./local-store --g ``` Then, search through any issue using: ```shell -github_search_engine search ""--db_path=./local-store --github_access_token= +github_search_engine search "" --db_path=./local-store --github_access_token= ``` ### Launching an API server diff --git a/docs/source/conf.py b/docs/source/conf.py index fff0876..b032f45 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -26,7 +26,7 @@ author = "Sacha hu" # The full version, including alpha/beta/rc tags -release = "0.2.1" +release = "0.2.2-rc.1" source_suffix = { ".rst": "restructuredtext", @@ -160,13 +160,13 @@ versions = [ ( tag_ref.name, - f"https://sachahu.com/docs/github-search-engine/pages/{tag_ref.name}", + f"https://www.sachahu.com/docs/Github-Search-Engine/pages/{tag_ref.name}", ) for tag_ref in git.Repo("../../").tags ] versions.append( - ("latest", "https://sachahu.com/docs/github-search-engine/latest") + ("latest", "https://www.sachahu.com/docs/Github-Search-Engine/latest") ) html_context = { diff --git a/docs/source/examples.rst b/docs/source/examples.rst new file mode 100644 index 0000000..5fedbcb --- /dev/null +++ b/docs/source/examples.rst @@ -0,0 +1,8 @@ +Examples +======== + +.. toctree:: + :maxdepth: 1 + :glob: + + /autoapi/examples/*/index diff --git a/examples/basic_example.py b/examples/basic_example.py index 55a2332..53af439 100644 --- a/examples/basic_example.py +++ b/examples/basic_example.py @@ -20,7 +20,9 @@ def run( repository_name: str, query: str, ): - github_search_engine = GithubSearchEngine(github_access_token) + github_search_engine = GithubSearchEngine( + github_access_token, qdrant_location=":memory:" + ) asyncio.run(github_search_engine.index_repository(owner, repository_name)) results = github_search_engine.search(owner, repository_name, query) diff --git a/github_search_engine/__init__.py b/github_search_engine/__init__.py index 57f2375..d626c7c 100644 --- a/github_search_engine/__init__.py +++ b/github_search_engine/__init__.py @@ -1,3 +1,3 @@ -__version__ = "0.2.1" +__version__ = "0.2.2-rc.1" from github_search_engine import _cli as _cli diff --git a/pyproject.toml b/pyproject.toml index 71d5bb7..5e03bd4 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -1,6 +1,6 @@ [tool.poetry] name = "Github-Search-Engine" -version = "0.2.1" +version = "0.2.2-rc.1" description = "Search through github issues and PRs like never before." authors = ["Sacha hu "] packages = [ @@ -9,7 +9,7 @@ packages = [ readme = "README.md" maintainers = ["Sacha hu "] repository = "https://github.com/sachahu1/Github-Search-Engine" -documentation = "https://sachahu.com/docs/github-search-engine/latest/index.html" +documentation = "https://www.sachahu.com/docs/Github-Search-Engine/latest/index.html" [tool.poetry.dependencies] python = ">=3.10,<3.14"