Skip to content

Commit c11f47e

Browse files
dependabot[bot]rjrudin
authored andcommitted
MLE-25780 Ruby docs updates
Bumps [nokogiri](https://github.com/sparklemotion/nokogiri) from 1.18.9 to 1.19.1. - [Release notes](https://github.com/sparklemotion/nokogiri/releases) - [Changelog](https://github.com/sparklemotion/nokogiri/blob/main/CHANGELOG.md) - [Commits](sparklemotion/nokogiri@v1.18.9...v1.19.1) --- updated-dependencies: - dependency-name: nokogiri dependency-version: 1.19.1 dependency-type: indirect ... Signed-off-by: dependabot[bot] <support@github.com>
1 parent 62f7825 commit c11f47e

File tree

4 files changed

+41
-22
lines changed

4 files changed

+41
-22
lines changed

.copyrightconfig

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ startyear: 2018
1010
# - Use sparingly (third_party, generated, binary assets)
1111
# - Dotfiles already skipped automatically
1212
# Enable by removing the leading '# ' from the next line and editing values.
13-
filesexcluded: .github/*, docs/*, README.md, Jenkinsfile, gradle/*, docker-compose.yml, *.gradle, gradle.properties, gradlew, gradlew.bat, **/test/resources/**, *.md, *.txt
13+
filesexcluded: .github/*, docs/*, *.md, Jenkinsfile, gradle/*, *.yml, *.gradle, gradle.properties, gradlew, gradlew.bat, **/test/resources/**, *.md, *.txt, *version, *.lock
Lines changed: 25 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,10 @@
1-
# Sample workflow for building and deploying a Jekyll site to GitHub Pages
2-
name: Deploy Jekyll with GitHub Pages dependencies preinstalled
1+
# Started with: https://github.com/actions/starter-workflows/blob/main/pages/jekyll.yml .
2+
# Have to use a custom Jekyll workflow as the default GitHub Jekyll workflow does not whitelist the
3+
# "jekyll-tabs" plugin that lets us show code tabs in the documentation.
4+
5+
name: Deploy Jekyll site to Pages
36

47
on:
5-
# Runs on pushes targeting the default branch
68
push:
79
branches: ["master"]
810

@@ -21,23 +23,33 @@ concurrency:
2123
cancel-in-progress: true
2224

2325
jobs:
24-
# Build job
2526
build:
2627
runs-on: ubuntu-latest
2728
steps:
2829
- name: Checkout
29-
uses: actions/checkout@v3
30+
uses: actions/checkout@v4
31+
- name: Setup Ruby and install Gemfile bundles
32+
uses: ruby/setup-ruby@v1
33+
with:
34+
ruby-version: '3.3.4' # Matches GH Pages; keep explicit to match .ruby-version and make CI intent clear
35+
bundler-cache: true # runs 'bundle install' and caches installed gems automatically
36+
working-directory: ./docs
37+
cache-version: 0 # Increment this number if you need to re-download cached gems
3038
- name: Setup Pages
31-
uses: actions/configure-pages@v3
39+
id: pages
40+
uses: actions/configure-pages@v5
3241
- name: Build with Jekyll
33-
uses: actions/jekyll-build-pages@v1
34-
with:
35-
source: ./docs/
36-
destination: ./_site
42+
working-directory: ./docs
43+
# Outputs to the './_site' directory by default
44+
run: bundle exec jekyll build --verbose --baseurl "${{ steps.pages.outputs.base_path }}"
45+
env:
46+
JEKYLL_ENV: production
3747
- name: Upload artifact
38-
uses: actions/upload-pages-artifact@v1
48+
# Automatically uploads an artifact from the './_site' directory by default
49+
uses: actions/upload-pages-artifact@v3
50+
with:
51+
path: "./docs/_site"
3952

40-
# Deployment job
4153
deploy:
4254
environment:
4355
name: github-pages
@@ -47,4 +59,4 @@ jobs:
4759
steps:
4860
- name: Deploy to GitHub Pages
4961
id: deployment
50-
uses: actions/deploy-pages@v1
62+
uses: actions/deploy-pages@v4

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ You can build and test the docs locally by
4040
though you don't need to perform all of those steps since some files generated by doing so are already in the
4141
`./docs` directory. You just need to do the following:
4242

43-
1. Install the latest Ruby (rbenv works well for this).
43+
1. Install the latest Ruby 3.x (rbenv works well for this).
4444
2. Install Jekyll.
4545
3. Go to the docs directory - `cd ./docs` .
4646
4. Run `bundle install` (this may not be necessary due to Gemfile.lock being in version control).

docs/Gemfile.lock

Lines changed: 14 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,12 @@ GEM
2424
ffi (>= 1.15.0)
2525
eventmachine (1.2.7)
2626
execjs (2.8.1)
27-
faraday (2.7.10)
28-
faraday-net_http (>= 2.0, < 3.1)
29-
ruby2_keywords (>= 0.0.4)
30-
faraday-net_http (3.0.2)
27+
faraday (2.14.1)
28+
faraday-net_http (>= 2.0, < 3.5)
29+
json
30+
logger
31+
faraday-net_http (3.4.2)
32+
net-http (~> 0.5)
3133
ffi (1.15.5)
3234
forwardable-extended (2.6.0)
3335
gemoji (3.0.1)
@@ -196,6 +198,7 @@ GEM
196198
gemoji (~> 3.0)
197199
html-pipeline (~> 2.2)
198200
jekyll (>= 3.0, < 5.0)
201+
json (2.18.1)
199202
kramdown (2.3.2)
200203
rexml
201204
kramdown-parser-gfm (1.1.0)
@@ -204,15 +207,18 @@ GEM
204207
listen (3.8.0)
205208
rb-fsevent (~> 0.10, >= 0.10.3)
206209
rb-inotify (~> 0.9, >= 0.9.10)
210+
logger (1.7.0)
207211
mercenary (0.3.6)
208212
minima (2.5.1)
209213
jekyll (>= 3.5, < 5.0)
210214
jekyll-feed (~> 0.9)
211215
jekyll-seo-tag (~> 2.1)
212216
minitest (5.19.0)
213-
nokogiri (1.18.9-arm64-darwin)
217+
net-http (0.9.1)
218+
uri (>= 0.11.1)
219+
nokogiri (1.19.1-arm64-darwin)
214220
racc (~> 1.4)
215-
nokogiri (1.18.9-x86_64-linux-gnu)
221+
nokogiri (1.19.1-x86_64-linux-gnu)
216222
racc (~> 1.4)
217223
octokit (4.25.1)
218224
faraday (>= 1, < 3)
@@ -226,7 +232,6 @@ GEM
226232
ffi (~> 1.0)
227233
rexml (3.4.2)
228234
rouge (3.26.0)
229-
ruby2_keywords (0.0.5)
230235
rubyzip (2.3.2)
231236
safe_yaml (1.0.5)
232237
sass (3.7.4)
@@ -249,11 +254,13 @@ GEM
249254
unf_ext
250255
unf_ext (0.0.8.2)
251256
unicode-display_width (1.8.0)
257+
uri (1.1.1)
252258
webrick (1.8.2)
253259

254260
PLATFORMS
255261
arm64-darwin-21
256262
arm64-darwin-23
263+
arm64-darwin-25
257264
x86_64-linux
258265

259266
DEPENDENCIES

0 commit comments

Comments
 (0)