Skip to content

Commit df947ee

Browse files
markpollackmarkpollack
committed
Setup initial github workflows for CI/CD and Issue Templates
1 parent ba10954 commit df947ee

5 files changed

Lines changed: 142 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Bug report
3+
about: Create a bug report to help us improve the project
4+
title: ''
5+
labels: 'type: bug, status: waiting-for-triage'
6+
assignees: ''
7+
8+
---
9+
10+
Please do a quick search on GitHub issues first, there might be already a duplicate issue for the one you are about to create.
11+
If the bug is trivial, just go ahead and create the issue. Otherwise, please take a few moments and fill in the following sections:
12+
13+
**Bug description**
14+
A clear and concise description of what the bug is about.
15+
16+
**Environment**
17+
Please provide as many details as possible: Spring MCP version, Java version, which vector store you use if any, etc
18+
19+
**Steps to reproduce**
20+
Steps to reproduce the issue.
21+
22+
**Expected behavior**
23+
A clear and concise description of what you expected to happen.
24+
25+
**Minimal Complete Reproducible example**
26+
Please provide a failing test or a minimal complete verifiable example that reproduces the issue.
27+
Bug reports that are reproducible will take priority in resolution over reports that are not reproducible.

‎.github/ISSUE_TEMPLATE/config.yml‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: Questions and Community Support
4+
url: https://stackoverflow.com/questions/tagged/spring-ai-mcp
5+
about: Please ask and answer questions on StackOverflow with the spring-ai tag

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: 'status: waiting-for-triage, type: feature'
6+
assignees: ''
7+
8+
---
9+
10+
Please do a quick search on GitHub issues first, the feature you are about to request might have already been requested.
11+
12+
**Expected Behavior**
13+
14+
<!--- Tell us how it should work. Add a code example to explain what you think the feature should look like. This is optional, but it would help up understand your expectations. -->
15+
16+
**Current Behavior**
17+
18+
<!--- Explain the difference from current behavior and why do you need this feature (aka why it is not possible to implement the desired functionality with the current version) -->
19+
20+
**Context**
21+
22+
<!---
23+
How has this issue affected you?
24+
What are you trying to accomplish?
25+
What other alternatives have you considered?
26+
Are you aware of any workarounds?
27+
-->

‎.github/ISSUE_TEMPLATE/miscellaneous.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: Miscellaneous
3+
about: Suggest an improvement for this project
4+
title: ''
5+
labels: 'status: waiting-for-triage'
6+
assignees: ''
7+
8+
---
9+
10+
For anything other than bug reports and feature requests (performance, refactoring, etc),
11+
just go ahead and file the issue. Please provide as many details as possible.
12+
13+
If you have a question or a support request, please open a new discussion on [GitHub Discussions](https://github.com/spring-projects-experimental/spring-ai-mcp/discussions)
14+
or ask a question on [StackOverflow](https://stackoverflow.com/questions/tagged/spring-ai-mcp).
15+
16+
Please do **not** create issues on the [Issue Tracker](https://github.com/spring-projects-experimental/spring-ai-mcp/issues) for questions or support requests.
17+
We would like to keep the issue tracker **exclusively** for bug reports and feature requests.

‎.github/workflows/continuous-integration.yml‎

Lines changed: 66 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,66 @@
1+
name: CI/CD build
2+
3+
on:
4+
push:
5+
branches: [ "main" ]
6+
7+
jobs:
8+
build:
9+
name: Build branch
10+
runs-on: ubuntu-latest
11+
steps:
12+
- name: Checkout source code
13+
uses: actions/checkout@v4
14+
15+
- name: Free Disk Space
16+
uses: jlumbroso/free-disk-space@54081f138730dfa15788a46383842cd2f914a1be # v1.3.1
17+
with:
18+
large-packages: false
19+
docker-images: false
20+
21+
- name: Set up JDK 17
22+
uses: actions/setup-java@v4
23+
with:
24+
java-version: '17'
25+
distribution: 'temurin'
26+
cache: 'maven'
27+
28+
- name: Build with Maven and deploy to Artifactory
29+
env:
30+
ARTIFACTORY_USERNAME: ${{ secrets.ARTIFACTORY_USERNAME }}
31+
ARTIFACTORY_PASSWORD: ${{ secrets.ARTIFACTORY_PASSWORD }}
32+
run: |
33+
mvn -s settings.xml -Pjavadoc --batch-mode --update-snapshots deploy
34+
35+
- name: Generate Java docs
36+
run: mvn javadoc:aggregate
37+
38+
- name: Capture project version
39+
run: echo PROJECT_VERSION=$(mvn help:evaluate -Dexpression=project.version --quiet -DforceStdout) >> $GITHUB_ENV
40+
41+
# - name: Generate assembly
42+
# working-directory: spring-ai-docs
43+
# run: mvn assembly:single
44+
45+
46+
# - name: Setup SSH key
47+
# env:
48+
# DOCS_SSH_KEY: ${{ secrets.DOCS_SSH_KEY }}
49+
# DOCS_SSH_HOST_KEY: ${{ secrets.DOCS_SSH_HOST_KEY }}
50+
# run: |
51+
# mkdir "$HOME/.ssh"
52+
# echo "$DOCS_SSH_KEY" > "$HOME/.ssh/key"
53+
# chmod 600 "$HOME/.ssh/key"
54+
# echo "$DOCS_SSH_HOST_KEY" > "$HOME/.ssh/known_hosts"
55+
#
56+
# - name: Deploy docs
57+
# env:
58+
# DOCS_HOST: ${{ secrets.DOCS_HOST }}
59+
# DOCS_PATH: ${{ secrets.DOCS_PATH }}
60+
# DOCS_USERNAME: ${{ secrets.DOCS_USERNAME }}
61+
# working-directory: spring-ai-docs/target
62+
# run: |
63+
# unzip spring-ai-$PROJECT_VERSION-docs.zip
64+
# ssh -i $HOME/.ssh/key $DOCS_USERNAME@$DOCS_HOST "cd $DOCS_PATH && mkdir -p $PROJECT_VERSION"
65+
# scp -i $HOME/.ssh/key -r api $DOCS_USERNAME@$DOCS_HOST:$DOCS_PATH/$PROJECT_VERSION
66+

0 commit comments

Comments
 (0)