Skip to content

Commit

Permalink
chore: Update publish workflow and add CHANGELOG for v0.1.1
Browse files Browse the repository at this point in the history
- Simplify publish.yml to use setup.py for building
- Add CHANGELOG.md for version 0.1.1
- Update version to 0.1.1 in setup.cfg

This commit prepares the project for the v0.1.1 release by updating
the GitHub Actions workflow and documenting changes in a standardized
CHANGELOG format.
  • Loading branch information
Jet Xu committed Aug 23, 2024
1 parent 6f47ca3 commit 8f30fe3
Show file tree
Hide file tree
Showing 5 changed files with 73 additions and 2 deletions.
29 changes: 29 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
name: Publish Python Package

on:
release:
types: [created]

jobs:
deploy:
runs-on: ubuntu-latest
permissions:
id-token: write
steps:
- uses: actions/checkout@v3
- name: Set up Python
uses: actions/setup-python@v4
with:
python-version: '3.x'
- name: Install dependencies
run: |
python -m pip install --upgrade pip
pip install setuptools wheel
- name: Build package
run: python setup.py sdist bdist_wheel
- name: List distribution files
run: ls -l dist/
- name: Publish package
uses: pypa/gh-action-pypi-publish@release/v1
with:
packages-dir: dist/
34 changes: 34 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Changelog

All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).

## [0.1.1] - 2024-08-23

### Added
- Implemented `answer_with_context` method for direct answer generation (closes #6)
- Added support for Mistral AI LLM provider
- Enhanced `retrieve_context` function to include metadata (e.g., URLs) with each context string (closes #2)

### Changed
- Improved reranking with jina-reranker-v2 for better context retrieval
- Updated return type of `retrieve_context` to accommodate metadata

### Fixed
- Resolved warning during context retrieval (closes #3)

### Improved
- Enhanced overall context retrieval process
- Expanded LLM support for more versatile use cases

## [0.1.0] - 2024-08-15

### Added
- Initial release of llama-github
- Basic functionality for retrieving context from GitHub repositories
- Integration with LLM for processing and generating responses

[0.1.1]: https://github.com/JetXu-LLM/llama-github/compare/v0.1.0...v0.1.1
[0.1.0]: https://github.com/JetXu-LLM/llama-github/releases/tag/v0.1.0
3 changes: 2 additions & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
include llama_github/config/config.json
include llama_github/config/config.json
include CHANGELOG.md
2 changes: 1 addition & 1 deletion setup.cfg
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ version = 0.1.1
author = Jet Xu
author_email = Voldemort.xu@foxmail.com
description = Llama-github is an open-source Python library that empowers LLM Chatbots, AI Agents, and Auto-dev Agents to conduct Retrieval from actively selected GitHub public projects. It Augments through LLMs and Generates context for any coding question, in order to streamline the development of sophisticated AI-driven applications.
long_description = file: README.md
long_description = file: README.md, CHANGELOG.md
long_description_content_type = text/markdown
url = https://github.com/JetXu-LLM/llama-github
classifiers =
Expand Down
7 changes: 7 additions & 0 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,9 +1,16 @@
from setuptools import setup, find_packages
from configparser import ConfigParser

# Read the requirements from requirements.txt
with open("requirements.txt", "r", encoding="utf-8") as fh:
requirements = fh.readlines()

# Read version from setup.cfg
config = ConfigParser()
config.read('setup.cfg')
version = config['metadata']['version']

setup(
version=version,
install_requires=[req.strip() for req in requirements],
)

0 comments on commit 8f30fe3

Please sign in to comment.