From aaaecc154bcf9dc23180645efb92a9a9ff7763f2 Mon Sep 17 00:00:00 2001 From: Evaline Ju <69598118+evaline-ju@users.noreply.github.com> Date: Thu, 2 Jan 2025 08:27:12 -0700 Subject: [PATCH] :construction_worker: Add CI for tests, lint, format and github issue templates (#5) * :memo: Issue templates Signed-off-by: Evaline Ju <69598118+evaline-ju@users.noreply.github.com> * :construction_worker: Add build, lint, format workflows Signed-off-by: Evaline Ju <69598118+evaline-ju@users.noreply.github.com> * :pushpin: Pin vllm upper bound Signed-off-by: Evaline Ju <69598118+evaline-ju@users.noreply.github.com> --------- Signed-off-by: Evaline Ju <69598118+evaline-ju@users.noreply.github.com> --- .github/ISSUE_TEMPLATE/bug_report.md | 34 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 +++++++++++++++ .github/ISSUE_TEMPLATE/user_story.md | 24 ++++++++++++++++ .github/workflows/build.yml | 23 +++++++++++++++ .github/workflows/lint-format.yml | 25 +++++++++++++++++ pyproject.toml | 2 +- 6 files changed, 130 insertions(+), 1 deletion(-) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/user_story.md create mode 100644 .github/workflows/build.yml create mode 100644 .github/workflows/lint-format.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..80d4b0a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,34 @@ +--- +name: Bug report +about: Create a report to help us improve +title: "" +labels: ["bug"] +assignees: "" +--- + +## Describe the bug + +A clear and concise description of what the bug is. + +## Platform + +Please provide details about the environment you are using, including the following: + +- Interpreter version: +- Library version: + +## Sample Code + +Please include a minimal sample of the code that will (if possible) reproduce the bug in isolation + +## Expected behavior + +A clear and concise description of what you expected to happen. + +## Observed behavior + +What you see happening (error messages, stack traces, etc...) + +## Additional context + +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..cf4dd73 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: "" +labels: "" +assignees: "" +--- + +## Is your feature request related to a problem? Please describe. + +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +## Describe the solution you'd like + +A clear and concise description of what you want to happen. + +## Describe alternatives you've considered + +A clear and concise description of any alternative solutions or features you've considered. + +## Additional context + +Add any other context about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/user_story.md b/.github/ISSUE_TEMPLATE/user_story.md new file mode 100644 index 0000000..1fdace3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/user_story.md @@ -0,0 +1,24 @@ +--- +name: User story +about: A user-oriented story describing a piece of work to do +title: "" +labels: "" +assignees: "" +--- + +## Description + +As a , I want to , so that I can + +## Discussion + +Provide detailed discussion here + +## Acceptance Criteria + + + +- [ ] Unit tests cover new/changed code +- [ ] Examples build against new/changed code +- [ ] READMEs are updated +- [ ] Type of [semantic version](https://semver.org/) change is identified diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 0000000..e85249e --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,23 @@ +name: Build and Test + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Set up Python 3.11 + uses: actions/setup-python@v4 + with: + python-version: 3.11 + - name: Install dependencies + run: | + python -m pip install --upgrade pip + python -m pip install -r setup_requirements.txt + - name: Build and test with tox + run: tox -e py diff --git a/.github/workflows/lint-format.yml b/.github/workflows/lint-format.yml new file mode 100644 index 0000000..2e3e50d --- /dev/null +++ b/.github/workflows/lint-format.yml @@ -0,0 +1,25 @@ +name: Lint and Format + +on: + push: + branches: [ "main" ] + pull_request: + branches: [ "main" ] + +jobs: + build: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Set up Python 3.11 + uses: actions/setup-python@v4 + with: + python-version: 3.11 + - name: Install dependencies + run: | + python -m pip install --upgrade pip + python -m pip install -r setup_requirements.txt + - name: Check Formatting + run: tox -e fmt + - name: Linting + run: tox -e lint diff --git a/pyproject.toml b/pyproject.toml index 51f7702..330d01a 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -13,7 +13,7 @@ classifiers = [ ] dependencies = [ - "vllm>=0.6.2" + "vllm>=0.6.2,<0.6.5" ] [project.optional-dependencies]