Skip to content

Commit 548be80

Browse files
committed
2.5.3, merge website and apidocs actions
1 parent f8ed6d1 commit 548be80

File tree

4 files changed

+64
-54
lines changed

4 files changed

+64
-54
lines changed

Diff for: .github/workflows/apidocs.yaml

-52
This file was deleted.

Diff for: .github/workflows/website.yaml

+48-1
Original file line numberDiff line numberDiff line change
@@ -6,10 +6,19 @@ on:
66
tags:
77
- 'v*' # Push events to matching v*, i.e. v1.0, v20.15.10
88
workflow_dispatch:
9+
inputs:
10+
publish_website:
11+
description: "Publish guides to website?"
12+
type: boolean
13+
required: true
14+
publish_version:
15+
description: "If present, pull this GraphQL-Ruby version to rebuild API docs"
16+
required: false
17+
type: string
918

1019
permissions: {}
1120
jobs:
12-
build:
21+
website:
1322
permissions:
1423
contents: write # for git push (s0/git-publish-subdir-action)
1524
name: Publish Website
@@ -43,3 +52,41 @@ jobs:
4352
BRANCH: gh-pages
4453
FOLDER: gh-pages
4554
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
55+
api_docs:
56+
needs: website
57+
if: ${{ inputs.publish_version || github.action_ref }}
58+
permissions:
59+
contents: write # for git push (s0/git-publish-subdir-action)
60+
name: Publish API Docs
61+
runs-on: ubuntu-latest
62+
steps:
63+
- name: Checkout release tag
64+
uses: actions/checkout@v4
65+
with:
66+
ref: ${{ env.GITHUB_REF }}
67+
- name: Checkout GitHub pages branch
68+
uses: actions/checkout@v4
69+
with:
70+
path: gh-pages
71+
ref: gh-pages
72+
- uses: ruby/setup-ruby@v1
73+
with:
74+
ruby-version: '3.2'
75+
bundler-cache: true
76+
- name: Build API docs
77+
run: |
78+
bundle exec rake site:fetch_latest apidocs:gen_version["${{ inputs.publish_version || env.GITHUB_REF }}"]
79+
- name: Commit changes as last committer
80+
run: |
81+
git config --global user.name rmosolgo
82+
git config --global user.email [email protected]
83+
git status
84+
bundle exec rake site:commit_changes
85+
git status
86+
- name: Deploy to GitHub pages via gh-pages branch
87+
uses: s0/git-publish-subdir-action@master
88+
env:
89+
REPO: self
90+
BRANCH: gh-pages
91+
FOLDER: gh-pages
92+
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

Diff for: CHANGELOG.md

+15
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,21 @@
1010

1111
### Bug fixes
1212

13+
# 2.5.3
14+
15+
### Deprecations
16+
17+
- Validation: two non-spec behaviors are deprecated:
18+
- When a query includes two scalar fields of different types which may occur in the same place in the response, the query was previously allowed. The spec says it should be rejected. This version emits a warning in this case. See `Schema.allow_legacy_invalid_return_type_conflicts` for migration support. #4351
19+
- When a query selects a field which returns a Union, but doesn't make any subselections on the Union, the spec says the query should be rejected as invalid but previous GraphQL-Ruby allowed it. It now emits a warning. See `Schema.allow_legacy_invalid_empty_selections_on_union` for migration support #5322
20+
- Complexity: several bugs about merging complexity cost across branches of a query have been fixed but require opting in. They may produce higher complexity scores. See `Schema.complexity_cost_calculation_mode` for migration support. #4843
21+
22+
### New features
23+
24+
- `AlwaysVisible`: improve speed (using `Schema::Visibility`) #5326
25+
- Return more descriptive errors when non-nullable list elements are `null` #5301
26+
- Visibility: improve performance on large schemas #5325
27+
1328
# 2.5.2
1429

1530
### New features

Diff for: lib/graphql/version.rb

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# frozen_string_literal: true
22
module GraphQL
3-
VERSION = "2.5.2"
3+
VERSION = "2.5.3"
44
end

0 commit comments

Comments
 (0)