Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

V1 docs #277

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

V1 docs #277

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f528f6e
adding toml to gitignore
pellicceama Feb 21, 2025
127430d
WIP tweaking release script
pellicceama Feb 24, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
297 changes: 154 additions & 143 deletions .github/workflows/release-workflow.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,147 +25,158 @@ jobs:
run: |
gh auth status

- name: Get the latest tag or set initial version
id: get_latest_tag
run: |
# Clean any local tags
git tag -l | xargs git tag -d
# Fetch all tags from remote
git fetch --prune --tags origin
LATEST_TAG=$(git tag -l "v*" --sort=-v:refname | head -n 1 || echo "v0.0.0")
echo "latest_tag=$LATEST_TAG" >> $GITHUB_ENV
echo "Found latest tag: $LATEST_TAG"
# Debug output
echo "All available tags:"
git tag -l

- name: Calculate new version
run: |
echo "latest_tag=${{ env.latest_tag }}"
# Split version into components and increment patch
LATEST_TAG_NO_V="${{ env.latest_tag }}"
LATEST_TAG_NO_V=${LATEST_TAG_NO_V#v} # Remove 'v' prefix
IFS='.' read -r MAJOR MINOR PATCH <<< "$LATEST_TAG_NO_V"
PATCH=$((PATCH + 1))
NEW_VERSION="v$MAJOR.$MINOR.$PATCH"

# Output the new version
echo "Final new version: $NEW_VERSION"
echo "new_version=$NEW_VERSION" >> $GITHUB_ENV

- name: Generate changelog
id: changelog
run: |
CHANGES=$(git log "${{ env.latest_tag }}"..HEAD --pretty=format:"- %s (%h) by %an")
echo "$CHANGES" > changes.txt
echo "Changes written to changes.txt"

- name: Fetch PR data as JSON
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
# Get the timestamp of the last tag
LAST_TAG_DATE=$(git log -1 --format=%ct ${{ env.latest_tag }})
LAST_TAG_ISO=$(date -u --date="@$LAST_TAG_DATE" +"%Y-%m-%dT%H:%M:%SZ")

# Get PRs merged after the last tag
gh pr list --state merged --base main --search "merged:>$LAST_TAG_ISO" \
--json number,title,body,author,mergedAt,labels > prs.json
echo "PR data saved to prs.json"

- name: Format PR data
run: |
jq -r '.[] | "- PR #\(.number): \(.title) by \(.author.login)\n> [!IMPORTANT]\n> \(.body // "No description provided.")\n"' prs.json > formatted_prs.txt
echo "Formatted PR data saved to formatted_prs.txt"

- name: Combine changelog and PR data
run: |
echo "Changes from git log:\n" > changelog.txt
cat changes.txt >> changelog.txt
echo "\nChanges from PRs:\n" >> changelog.txt
cat formatted_prs.txt >> changelog.txt
echo "Combined changelog written to changelog.txt"

- name: Extract PR titles and important lines
id: parse_changelog
run: |
awk -v repo_url="https://github.com/openintegrations/openint" '
BEGIN {
last_pr_number = "";
}
/^- PR #[0-9]+:/ {
match($0, /^- PR #([0-9]+):/, pr);
pr_title = $0;
pr_number = pr[1];
}
/> \[!IMPORTANT\]/ {
getline;
important_line = $0;
if (pr_number != last_pr_number) {
last_pr_number = pr_number;
print pr_title " (" repo_url "/pull/" pr_number ") -- " important_line;
}
}' changelog.txt > formatted_release_notes.txt
echo "Formatted Release Notes:"
cat formatted_release_notes.txt
- name: Summarize PR changes with OpenAI
id: summarize
env:
OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
run: |
FORMATTED_OUTPUT=$(cat formatted_release_notes.txt | jq -Rsa .)

RESPONSE=$(curl -s -X POST https://api.openai.com/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer $OPENAI_API_KEY" \
-d "$(jq -n --arg changelog "$FORMATTED_OUTPUT" '{
model: "gpt-4",
messages: [
{role: "system", content: "You are an assistant that generates concise and clear release summaries for software projects."},
{role: "user", content: ("Summarize the following PR changes into a single two-liner summary highlighting important changes in casual tone of voice:\n\n" + $changelog)}
],
temperature: 0.7
}')")

echo "OpenAI API Response:"
echo "$RESPONSE"

SUMMARY=$(echo "$RESPONSE" | jq -r '.choices[0].message.content // "No summary generated"')
echo "summary=$SUMMARY" >> $GITHUB_ENV
echo "$SUMMARY" > summary_output.txt

- name: Create Release Notes
run: |
SUMMARY=$(cat summary_output.txt)
echo -e "### Summary\n\n$SUMMARY\n\n### PR Breakdown:\n" > release_notes.txt
cat formatted_release_notes.txt >> release_notes.txt
echo "Release notes written to release_notes.txt"

- name: Create GitHub Release
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
run: |
gh release create "${{ env.new_version }}" --title "Release ${{ env.new_version }}" --notes-file release_notes.txt

- name: Update production branch
run: |
git config user.name "GitHub Actions Bot"
git config user.email "<>"
git fetch origin main
git checkout main
git push origin main:production -f
- uses: UnlyEd/github-action-await-vercel@v1 # TODO best practices recommend to use a fixed version instead of @v1 for production usage (i.e: @v1.2.32)
id: await-vercel
env:
VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
with:
deployment-url: openint-git-main-openint-dev.vercel.app # TODO Replace by the domain you want to test
timeout: 10 # Wait for 10 seconds before failing
poll-interval: 1 # Wait for 1 second before each retry

- name: Stably Runner Action
id: stably-runner
uses: stablyhq/stably-runner-action@v3
# - name: Get the latest tag or set initial version
# id: get_latest_tag
# run: |
# # Clean any local tags
# git tag -l | xargs git tag -d
# # Fetch all tags from remote
# git fetch --prune --tags origin
# LATEST_TAG=$(git tag -l "v*" --sort=-v:refname | head -n 1 || echo "v0.0.0")
# echo "latest_tag=$LATEST_TAG" >> $GITHUB_ENV
# echo "Found latest tag: $LATEST_TAG"
# # Debug output
# echo "All available tags:"
# git tag -l

# - name: Calculate new version
# run: |
# echo "latest_tag=${{ env.latest_tag }}"
# # Split version into components and increment patch
# LATEST_TAG_NO_V="${{ env.latest_tag }}"
# LATEST_TAG_NO_V=${LATEST_TAG_NO_V#v} # Remove 'v' prefix
# IFS='.' read -r MAJOR MINOR PATCH <<< "$LATEST_TAG_NO_V"
# PATCH=$((PATCH + 1))
# NEW_VERSION="v$MAJOR.$MINOR.$PATCH"

# # Output the new version
# echo "Final new version: $NEW_VERSION"
# echo "new_version=$NEW_VERSION" >> $GITHUB_ENV

# - name: Generate changelog
# id: changelog
# run: |
# CHANGES=$(git log "${{ env.latest_tag }}"..HEAD --pretty=format:"- %s (%h) by %an")
# echo "$CHANGES" > changes.txt
# echo "Changes written to changes.txt"

# - name: Fetch PR data as JSON
# env:
# GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# run: |
# # Get the timestamp of the last tag
# LAST_TAG_DATE=$(git log -1 --format=%ct ${{ env.latest_tag }})
# LAST_TAG_ISO=$(date -u --date="@$LAST_TAG_DATE" +"%Y-%m-%dT%H:%M:%SZ")

# # Get PRs merged after the last tag
# gh pr list --state merged --base main --search "merged:>$LAST_TAG_ISO" \
# --json number,title,body,author,mergedAt,labels > prs.json
# echo "PR data saved to prs.json"

# - name: Format PR data
# run: |
# jq -r '.[] | "- PR #\(.number): \(.title) by \(.author.login)\n> [!IMPORTANT]\n> \(.body // "No description provided.")\n"' prs.json > formatted_prs.txt
# echo "Formatted PR data saved to formatted_prs.txt"

# - name: Combine changelog and PR data
# run: |
# echo "Changes from git log:\n" > changelog.txt
# cat changes.txt >> changelog.txt
# echo "\nChanges from PRs:\n" >> changelog.txt
# cat formatted_prs.txt >> changelog.txt
# echo "Combined changelog written to changelog.txt"

# - name: Extract PR titles and important lines
# id: parse_changelog
# run: |
# awk -v repo_url="https://github.com/openintegrations/openint" '
# BEGIN {
# last_pr_number = "";
# }
# /^- PR #[0-9]+:/ {
# match($0, /^- PR #([0-9]+):/, pr);
# pr_title = $0;
# pr_number = pr[1];
# }
# /> \[!IMPORTANT\]/ {
# getline;
# important_line = $0;
# if (pr_number != last_pr_number) {
# last_pr_number = pr_number;
# print pr_title " (" repo_url "/pull/" pr_number ") -- " important_line;
# }
# }' changelog.txt > formatted_release_notes.txt
# echo "Formatted Release Notes:"
# cat formatted_release_notes.txt
# - name: Summarize PR changes with OpenAI
# id: summarize
# env:
# OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
# run: |
# FORMATTED_OUTPUT=$(cat formatted_release_notes.txt | jq -Rsa .)

# RESPONSE=$(curl -s -X POST https://api.openai.com/v1/chat/completions \
# -H "Content-Type: application/json" \
# -H "Authorization: Bearer $OPENAI_API_KEY" \
# -d "$(jq -n --arg changelog "$FORMATTED_OUTPUT" '{
# model: "gpt-4",
# messages: [
# {role: "system", content: "You are an assistant that generates concise and clear release summaries for software projects."},
# {role: "user", content: ("Summarize the following PR changes into a single two-liner summary highlighting important changes in casual tone of voice:\n\n" + $changelog)}
# ],
# temperature: 0.7
# }')")

# echo "OpenAI API Response:"
# echo "$RESPONSE"

# SUMMARY=$(echo "$RESPONSE" | jq -r '.choices[0].message.content // "No summary generated"')
# echo "summary=$SUMMARY" >> $GITHUB_ENV
# echo "$SUMMARY" > summary_output.txt

# - name: Create Release Notes
# run: |
# SUMMARY=$(cat summary_output.txt)
# echo -e "### Summary\n\n$SUMMARY\n\n### PR Breakdown:\n" > release_notes.txt
# cat formatted_release_notes.txt >> release_notes.txt
# echo "Release notes written to release_notes.txt"

- name: Push spec and config to Stainless and output documented spec
uses: stainless-api/upload-openapi-spec-action@main
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider pinning the version of the stainless-api/upload-openapi-spec-action instead of using @main to avoid unexpected changes. Use a specific version or commit hash.

Suggested change
uses: stainless-api/upload-openapi-spec-action@main
uses: stainless-api/upload-openapi-spec-action@v1.0.0

with:
api-key: ${{ secrets.STABLY_API_KEY }}
test-group-id: cm5g8i6nc0005l103urkixuxz
stainless_api_key: ${{ secrets.STAINLESS_API_KEY }}
input_path: '/packages-v1/api-v1/__generated__/openapi.json'
output_path: '/packages-v1/api-v1/__generated__/openapi.documented.json'
project_name: 'openint'
commit_message: 'feat(docs): updating documented docs for mintlify'

## TODO: Reenable the below steps

# - name: Create GitHub Release
# env:
# GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
# run: |
# gh release create "${{ env.new_version }}" --title "Release ${{ env.new_version }}" --notes-file release_notes.txt

# - name: Update production branch
# run: |
# git config user.name "GitHub Actions Bot"
# git config user.email "<>"
# git fetch origin main
# git checkout main
# git push origin main:production -f
# - uses: UnlyEd/github-action-await-vercel@v1 # TODO best practices recommend to use a fixed version instead of @v1 for production usage (i.e: @v1.2.32)
# id: await-vercel
# env:
# VERCEL_TOKEN: ${{ secrets.VERCEL_TOKEN }}
# with:
# deployment-url: openint-git-main-openint-dev.vercel.app # TODO Replace by the domain you want to test
# timeout: 10 # Wait for 10 seconds before failing
# poll-interval: 1 # Wait for 1 second before each retry

# - name: Stably Runner Action
# id: stably-runner
# uses: stablyhq/stably-runner-action@v3
# with:
# api-key: ${{ secrets.STABLY_API_KEY }}
# test-group-id: cm5g8i6nc0005l103urkixuxz
1 change: 1 addition & 0 deletions .gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,6 +65,7 @@ dist/
/gateway/wrangler.toml

.dev.vars
wrangler.toml

# CI Artifacts
/artifacts
Expand Down