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.

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

Style: Modernize yaml formatting & syntax #963

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
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
50 changes: 25 additions & 25 deletions .github/workflows/build-pr.yml
Original file line number Diff line number Diff line change
Expand Up @@ -13,28 +13,28 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3

# Configure the build environment.

- name: Install Ruby 3.1
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.1'
# Runs 'bundle install' and caches installed gems automatically
bundler-cache: true

- name: Install Minify
run: sudo apt-get update && sudo apt-get install minify

# Build the website.

- name: Build the static website
run: bundle exec jekyll build

# Upload resulting "_site" directory as artifact

- uses: actions/upload-artifact@v4
with:
name: site
path: _site/
- name: Checkout
uses: actions/checkout@v4
with:
submodules: recursive

# Configure the build environment.
- name: Install Ruby 3.1
uses: ruby/setup-ruby@v1
with:
ruby-version: 3.1
# Runs 'bundle install' and caches installed gems automatically.
bundler-cache: true

- name: Install Minify
run: sudo apt-get update && sudo apt-get install minify

# Build the website.
- name: Build the static website
run: bundle exec jekyll build

# Upload resulting "_site" directory as artifact.
- uses: actions/upload-artifact@v4
with:
name: site
path: _site/
68 changes: 33 additions & 35 deletions .github/workflows/build-website.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ name: Build and publish
on:
workflow_dispatch:
push:
branches: [ master ]
branches: [master]

# Make sure jobs cannot overlap (e.g. one from push and one from schedule).
concurrency:
Expand All @@ -16,37 +16,35 @@ jobs:
runs-on: ubuntu-latest

steps:
- uses: actions/checkout@v3
with:
ref: 'master'

# Configure the build environment.

- name: Install Ruby 3.1
uses: ruby/setup-ruby@v1
with:
ruby-version: '3.1'
# Runs 'bundle install' and caches installed gems automatically
bundler-cache: true

- name: Install Minify
run: sudo apt-get update && sudo apt-get install minify

# Build the website.

- name: Build the static website
run: bundle exec jekyll build


# Publish the build results

- name: Deploy to the published branch 🚀
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: published
folder: _site
# Configure the commit author.
git-config-name: 'Godot Organization'
git-config-email: '<>'
# Remove outdated files from the target directory.
clean: true
- name: Checkout
uses: actions/checkout@v4
with:
ref: master
submodules: recursive

# Configure the build environment.
- name: Install Ruby 3.1
uses: ruby/setup-ruby@v1
with:
ruby-version: 3.1
# Runs 'bundle install' and caches installed gems automatically.
bundler-cache: true

- name: Install Minify
run: sudo apt-get update && sudo apt-get install minify

# Build the website.
- name: Build the static website
run: bundle exec jekyll build

# Publish the build results.
- name: Deploy to the published branch 🚀
uses: JamesIves/github-pages-deploy-action@v4
with:
branch: published
folder: _site
# Configure the commit author.
git-config-name: Godot Organization
git-config-email: <>
# Remove outdated files from the target directory.
clean: true
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -172,11 +172,11 @@ build available for download.

To create a new version, add the following block to the file:

```
- name: "4.0.1"
flavor: "stable"
release_date: "20 March 2023"
release_notes: "/article/maintenance-release-godot-4-0-1/"
```yaml
- name: '4.0.1'
flavor: stable
release_date: 20 March 2023
release_notes: /article/maintenance-release-godot-4-0-1/
```

Make sure to order entries correctly, with the higher version number being closer to the top. Use the `flavor` field
Expand All @@ -188,12 +188,12 @@ information. Make sure to update this information when publishing the release no

Stable releases featured across the website, must be marked with the `featured` field and the corresponding major version number. Only one record must be marked as featured per version, so don't forget to remove it from the current holder of the mark.

```
- name: "4.0.3"
flavor: "stable"
release_date: "19 May 2023"
release_notes: "/article/maintenance-release-godot-4-0-3/"
featured: "4"
```yaml
- name: '4.0.3'
flavor: stable
release_date: 19 May 2023
release_notes: /article/maintenance-release-godot-4-0-3/
featured: '4'
```

There are two additional files providing data for download pages and links: `_data/download_configs.yml` and
Expand All @@ -206,10 +206,10 @@ some pages.
If a new host needs to be supported by the mirrorlist, it needs to be added in a few places. For the data side of
things you need to update `_data/mirrorlist_configs.yml` and add another record for the major-minor version code.

```
- name: "4.1"
stable: [ "github", "tuxfamily" ]
preview: [ "github_builds", "tuxfamily" ]
```yaml
- name: '4.1'
stable: [github, tuxfamily]
preview: [github_builds, tuxfamily]
```

The `stable` key refers to hosts available for the stable release of that version, while the `preview` key refers
Expand Down
2 changes: 1 addition & 1 deletion _config.development.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Overrides from the main config
url: "http://localhost:4000"
url: http://localhost:4000

# Enables incremental builds to speed up iteration times.
incremental: true
Expand Down
68 changes: 33 additions & 35 deletions _config.yml
Original file line number Diff line number Diff line change
@@ -1,17 +1,15 @@
# Settings
exclude:
[
".github",
"Gemfile",
"Gemfile.lock",
"build.sh",
"build-and-serve.sh",
"build-and-watch.sh",
"README.md",
]
- .github,
- build-and-serve.sh,
- build-and-watch.sh,
- build.sh,
- Gemfile,
- Gemfile.lock,
- README.md,
permalink: pretty

url: "https://godotengine.org"
url: https://godotengine.org

collections_dir: collections
collections:
Expand All @@ -32,34 +30,34 @@ future: true

defaults:
- scope:
type: "article"
type: article
values:
layout: "article"
og_type: "article"
layout: article
og_type: article
- scope:
type: "event"
type: event
values:
layout: "event"
layout: event
- scope:
type: "showcase"
type: showcase
values:
layout: "showcase-item"
layout: showcase-item
- scope:
type: "download"
type: download
values:
layout: "download"
layout: download
- scope:
type: "download_3"
type: download_3
values:
layout: "download-3"
layout: download-3
- scope:
type: "download_archive"
type: download_archive
values:
layout: "download-archive"
layout: download-archive
- scope:
type: "mirrorlist"
type: mirrorlist
values:
layout: "mirrorlist"
layout: mirrorlist

# Plugins
plugins:
Expand All @@ -68,29 +66,29 @@ plugins:
# - jekyll-multiple-languages-plugin

# Internationalization
languages: ["en", "es"]
exclude_from_localizations: ["assets", "storage"]
default_lang: "en"
languages: [en, es]
exclude_from_localizations: [assets, storage]
default_lang: en

# Pagination (used by the blog)
pagination:
enabled: true
debug: false

collection: "article"
collection: article
per_page: 24
sort_field: "date"
sort_field: date
sort_reverse: true
# Controls how the pagination trail for the paginated pages look like.
trail:
before: 2
after: 2

title: ":title - Page :num"
permalink: "/:num/"
category: "posts"
tag: ""
locale: ""
title: :title - Page :num
permalink: /:num/
category: posts
tag: ''
locale: ''

# .scss generation
sass:
Expand Down
6 changes: 3 additions & 3 deletions _data/authors.yml
Original file line number Diff line number Diff line change
Expand Up @@ -74,11 +74,11 @@
image: /assets/images/authors/default_avatar.svg
- name: Yuri Sizov
image: /assets/images/authors/yuri.jpeg
- name: "2000+ Godot contributors"
- name: 2000+ Godot contributors
image: /assets/images/authors/everyone.webp
- name: "Godot contributors"
- name: Godot contributors
image: /assets/images/authors/everyone.webp
- name: "Godot Foundation"
- name: Godot Foundation
image: /assets/images/authors/foundation.webp
- name: default
image: /assets/images/authors/default_avatar.svg
16 changes: 8 additions & 8 deletions _data/download_configs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -79,8 +79,8 @@ overrides:
# Mono version of Godot 4 was only introduced in 4.0 alpha 17.
- version: 4
range:
- "4.0-alpha1"
- "4.0-alpha16"
- 4.0-alpha1
- 4.0-alpha16
config:
templates: export_templates.tpz
editor:
Expand All @@ -97,8 +97,8 @@ overrides:
# Godot 4.2 beta 5 introduced Linux ARM builds.
- version: 4
range:
- "4.0-alpha17"
- "4.2-beta4"
- 4.0-alpha17
- 4.2-beta4
config:
templates: export_templates.tpz
editor:
Expand All @@ -123,8 +123,8 @@ overrides:
# Godot 4.3 RC 1 introduced Windows ARM builds.
- version: 4
range:
- "4.2-beta5"
- "4.3-beta3"
- 4.2-beta5
- 4.3-beta3
config:
templates: export_templates.tpz
editor:
Expand Down Expand Up @@ -153,8 +153,8 @@ overrides:
# Godot 4.4 dev 2 introduced Android Horizon OS builds.
- version: 4
range:
- "4.3-rc1"
- "4.4-dev1"
- 4.3-rc1
- 4.4-dev1
config:
templates: export_templates.tpz
editor:
Expand Down
Loading