From 702796dd3962a1c9935ff736d5b27d25050d0cf6 Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Fri, 18 Oct 2024 09:16:21 +0000 Subject: [PATCH 1/6] Update dependency mezzio/mezzio to ^3.20.1 | datasource | package | from | to | | ---------- | ------------- | ------ | ------ | | packagist | mezzio/mezzio | 3.20.0 | 3.20.1 | Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- composer.json | 2 +- composer.lock | 34 +++++++++++++++++----------------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/composer.json b/composer.json index 003a0db9..7a88eb46 100644 --- a/composer.json +++ b/composer.json @@ -47,7 +47,7 @@ "laminas/laminas-servicemanager": "^3.22.1", "laminas/laminas-stdlib": "^3.19.0", "league/commonmark": "^2.5.1", - "mezzio/mezzio": "^3.20.0", + "mezzio/mezzio": "^3.20.1", "mezzio/mezzio-fastroute": "^3.12.0", "mezzio/mezzio-helpers": "^5.17.0", "mezzio/mezzio-platesrenderer": "^2.11.0", diff --git a/composer.lock b/composer.lock index 281dcc1f..4661519c 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "e2817f9332e787b480ddb6cc01b349b5", + "content-hash": "36c124e61939f9efe6c31d8cbe453044", "packages": [ { "name": "brick/varexporter", @@ -683,30 +683,30 @@ }, { "name": "laminas/laminas-httphandlerrunner", - "version": "2.10.0", + "version": "2.11.0", "source": { "type": "git", "url": "https://github.com/laminas/laminas-httphandlerrunner.git", - "reference": "35a0ba92e940a2f9533754f5a56187fa321f7693" + "reference": "c428d9f67f280d155637cbe2b7245b5188c8cdae" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/laminas/laminas-httphandlerrunner/zipball/35a0ba92e940a2f9533754f5a56187fa321f7693", - "reference": "35a0ba92e940a2f9533754f5a56187fa321f7693", + "url": "https://api.github.com/repos/laminas/laminas-httphandlerrunner/zipball/c428d9f67f280d155637cbe2b7245b5188c8cdae", + "reference": "c428d9f67f280d155637cbe2b7245b5188c8cdae", "shasum": "" }, "require": { - "php": "~8.1.0 || ~8.2.0 || ~8.3.0", + "php": "~8.1.0 || ~8.2.0 || ~8.3.0 || ~8.4.0", "psr/http-message": "^1.0 || ^2.0", "psr/http-message-implementation": "^1.0 || ^2.0", "psr/http-server-handler": "^1.0" }, "require-dev": { - "laminas/laminas-coding-standard": "~2.5.0", - "laminas/laminas-diactoros": "^3.3.0", - "phpunit/phpunit": "^10.5.5", - "psalm/plugin-phpunit": "^0.18.4", - "vimeo/psalm": "^5.18" + "laminas/laminas-coding-standard": "~3.0.0", + "laminas/laminas-diactoros": "^3.4.0", + "phpunit/phpunit": "^10.5.36", + "psalm/plugin-phpunit": "^0.19.0", + "vimeo/psalm": "^5.26.1" }, "type": "library", "extra": { @@ -746,7 +746,7 @@ "type": "community_bridge" } ], - "time": "2024-01-04T10:50:34+00:00" + "time": "2024-10-17T20:37:17+00:00" }, { "name": "laminas/laminas-paginator", @@ -1309,16 +1309,16 @@ }, { "name": "mezzio/mezzio", - "version": "3.20.0", + "version": "3.20.1", "source": { "type": "git", "url": "https://github.com/mezzio/mezzio.git", - "reference": "a51fb6e501fd8ca32eb1804e9a611c3819d93494" + "reference": "e60bb257e91cdeb9304b02c28b8c72dcc45b38b0" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/mezzio/mezzio/zipball/a51fb6e501fd8ca32eb1804e9a611c3819d93494", - "reference": "a51fb6e501fd8ca32eb1804e9a611c3819d93494", + "url": "https://api.github.com/repos/mezzio/mezzio/zipball/e60bb257e91cdeb9304b02c28b8c72dcc45b38b0", + "reference": "e60bb257e91cdeb9304b02c28b8c72dcc45b38b0", "shasum": "" }, "require": { @@ -1411,7 +1411,7 @@ "type": "community_bridge" } ], - "time": "2024-10-16T21:50:20+00:00" + "time": "2024-10-18T07:47:27+00:00" }, { "name": "mezzio/mezzio-fastroute", From 806a42c553382084122c21ced244beda5bb59f7d Mon Sep 17 00:00:00 2001 From: "renovate[bot]" <29139614+renovate[bot]@users.noreply.github.com> Date: Mon, 21 Oct 2024 01:18:57 +0000 Subject: [PATCH 2/6] Lock file maintenance Signed-off-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com> --- bootstrap/package-lock.json | 54 +++++++++++++++-------------------- composer.lock | 56 ++++++++++++++++++------------------- 2 files changed, 50 insertions(+), 60 deletions(-) diff --git a/bootstrap/package-lock.json b/bootstrap/package-lock.json index 75ccfdd9..f4d32dd9 100644 --- a/bootstrap/package-lock.json +++ b/bootstrap/package-lock.json @@ -449,9 +449,9 @@ } }, "node_modules/acorn": { - "version": "8.12.1", - "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.12.1.tgz", - "integrity": "sha512-tcpGyI9zbizT9JbV6oYE477V6mTlXvvi0T0G3SNIYE2apm/G5huBa1+K89VGeovbg+jycCrfhl3ADxErOuO6Jg==", + "version": "8.13.0", + "resolved": "https://registry.npmjs.org/acorn/-/acorn-8.13.0.tgz", + "integrity": "sha512-8zSiw54Oxrdym50NlZ9sUusyO1Z1ZchgRLWRaK6c86XJFClyCgFKetdowBg5bKxyp/u+CDBJG4Mpp0m3HLZl9w==", "dev": true, "license": "MIT", "bin": { @@ -671,13 +671,6 @@ "postcss": "^8.1.0" } }, - "node_modules/b4a": { - "version": "1.6.7", - "resolved": "https://registry.npmjs.org/b4a/-/b4a-1.6.7.tgz", - "integrity": "sha512-OnAYlL5b7LEkALw87fUVafQw5rVR9RjwGd4KUwNQ6DrrNmaVaUCgLipfVlzrPQ4tWOR9P0IXGNOx50jYCCdSJg==", - "dev": true, - "license": "Apache-2.0" - }, "node_modules/bach": { "version": "2.0.1", "resolved": "https://registry.npmjs.org/bach/-/bach-2.0.1.tgz", @@ -864,9 +857,9 @@ "license": "MIT" }, "node_modules/caniuse-lite": { - "version": "1.0.30001668", - "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001668.tgz", - "integrity": "sha512-nWLrdxqCdblixUO+27JtGJJE/txpJlyUy5YN1u53wLZkP0emYCo5zgS6QYft7VUYR42LGgi/S5hdLZTrnyIddw==", + "version": "1.0.30001669", + "resolved": "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001669.tgz", + "integrity": "sha512-DlWzFDJqstqtIVx1zeSpIMLjunf5SmwOw0N2Ck/QSQdS8PLS4+9HrLaYei4w8BIAL7IB/UEDu889d8vhCTPA0w==", "dev": true, "funding": [ { @@ -1225,9 +1218,9 @@ } }, "node_modules/electron-to-chromium": { - "version": "1.5.36", - "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.36.tgz", - "integrity": "sha512-HYTX8tKge/VNp6FGO+f/uVDmUkq+cEfcxYhKf15Akc4M5yxt5YmorwlAitKWjWhWQnKcDRBAQKXkhqqXMqcrjw==", + "version": "1.5.41", + "resolved": "https://registry.npmjs.org/electron-to-chromium/-/electron-to-chromium-1.5.41.tgz", + "integrity": "sha512-dfdv/2xNjX0P8Vzme4cfzHqnPm5xsZXwsolTYr0eyW18IUmNyG08vL+fttvinTfhKfIKdRoqkDIC9e9iWQCNYQ==", "dev": true, "license": "ISC" }, @@ -2778,9 +2771,9 @@ } }, "node_modules/picocolors": { - "version": "1.1.0", - "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.0.tgz", - "integrity": "sha512-TQ92mBOW0l3LeMeyLV6mzy/kWr8lkd/hp3mTg7wYK7zJhuBStmGMBG0BdeDZS/dZx1IukaX6Bk11zcln25o1Aw==", + "version": "1.1.1", + "resolved": "https://registry.npmjs.org/picocolors/-/picocolors-1.1.1.tgz", + "integrity": "sha512-xceH2snhtb5M9liqDsmEw56le376mTZkEX/jEb/RxNFyegNul7eNslCXP9FDj/Lcu0X8KEyMceP2ntpaHrDEVA==", "dev": true, "license": "ISC" }, @@ -3139,9 +3132,9 @@ "license": "MIT" }, "node_modules/sass": { - "version": "1.79.5", - "resolved": "https://registry.npmjs.org/sass/-/sass-1.79.5.tgz", - "integrity": "sha512-W1h5kp6bdhqFh2tk3DsI771MoEJjvrSY/2ihJRJS4pjIyfJCw0nTsxqhnrUzaLMOJjFchj8rOvraI/YUVjtx5g==", + "version": "1.80.3", + "resolved": "https://registry.npmjs.org/sass/-/sass-1.80.3.tgz", + "integrity": "sha512-ptDWyVmDMVielpz/oWy3YP3nfs7LpJTHIJZboMVs8GEC9eUmtZTZhMHlTW98wY4aEorDfjN38+Wr/XjskFWcfA==", "dev": true, "license": "MIT", "dependencies": { @@ -3402,9 +3395,9 @@ } }, "node_modules/terser": { - "version": "5.34.1", - "resolved": "https://registry.npmjs.org/terser/-/terser-5.34.1.tgz", - "integrity": "sha512-FsJZ7iZLd/BXkz+4xrRTGJ26o/6VTjQytUk8b8OxkwcD2I+79VPJlz7qss1+zE7h8GNIScFqXcDyJ/KqBYZFVA==", + "version": "5.36.0", + "resolved": "https://registry.npmjs.org/terser/-/terser-5.36.0.tgz", + "integrity": "sha512-IYV9eNMuFAV4THUspIRXkLakHnV6XO7FEdtKjf/mDyrnqUg9LnlOn6/RwRvM9SZjR4GUq8Nk8zj67FzVARr74w==", "dev": true, "license": "BSD-2-Clause", "dependencies": { @@ -3421,14 +3414,11 @@ } }, "node_modules/text-decoder": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/text-decoder/-/text-decoder-1.2.0.tgz", - "integrity": "sha512-n1yg1mOj9DNpk3NeZOx7T6jchTbyJS3i3cucbNN6FcdPriMZx7NsgrGpWWdWZZGxD7ES1XB+3uoqHMgOKaN+fg==", + "version": "1.2.1", + "resolved": "https://registry.npmjs.org/text-decoder/-/text-decoder-1.2.1.tgz", + "integrity": "sha512-x9v3H/lTKIJKQQe7RPQkLfKAnc9lUTkWDypIQgTzPJAq+5/GCDHonmshfvlsNSj58yyshbIJJDLmU15qNERrXQ==", "dev": true, - "license": "Apache-2.0", - "dependencies": { - "b4a": "^1.6.4" - } + "license": "Apache-2.0" }, "node_modules/through2": { "version": "3.0.1", diff --git a/composer.lock b/composer.lock index 4661519c..4b70a8fa 100644 --- a/composer.lock +++ b/composer.lock @@ -5785,16 +5785,16 @@ }, { "name": "phpunit/phpunit", - "version": "10.5.36", + "version": "10.5.37", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/phpunit.git", - "reference": "aa0a8ce701ea7ee314b0dfaa8970dc94f3f8c870" + "reference": "c7cffa0efa2b70c22366523e6d804c9419eb2400" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/aa0a8ce701ea7ee314b0dfaa8970dc94f3f8c870", - "reference": "aa0a8ce701ea7ee314b0dfaa8970dc94f3f8c870", + "url": "https://api.github.com/repos/sebastianbergmann/phpunit/zipball/c7cffa0efa2b70c22366523e6d804c9419eb2400", + "reference": "c7cffa0efa2b70c22366523e6d804c9419eb2400", "shasum": "" }, "require": { @@ -5815,7 +5815,7 @@ "phpunit/php-timer": "^6.0.0", "sebastian/cli-parser": "^2.0.1", "sebastian/code-unit": "^2.0.0", - "sebastian/comparator": "^5.0.2", + "sebastian/comparator": "^5.0.3", "sebastian/diff": "^5.1.1", "sebastian/environment": "^6.1.0", "sebastian/exporter": "^5.1.2", @@ -5866,7 +5866,7 @@ "support": { "issues": "https://github.com/sebastianbergmann/phpunit/issues", "security": "https://github.com/sebastianbergmann/phpunit/security/policy", - "source": "https://github.com/sebastianbergmann/phpunit/tree/10.5.36" + "source": "https://github.com/sebastianbergmann/phpunit/tree/10.5.37" }, "funding": [ { @@ -5882,7 +5882,7 @@ "type": "tidelift" } ], - "time": "2024-10-08T15:36:51+00:00" + "time": "2024-10-19T13:03:41+00:00" }, { "name": "psalm/plugin-phpunit", @@ -5950,17 +5950,17 @@ "source": { "type": "git", "url": "https://github.com/Roave/SecurityAdvisories.git", - "reference": "c3c55a0f6643119fa8699577cc83ca6256d98ab5" + "reference": "2db4b93f047a03be06ec0a890d252e1c8c635f74" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/Roave/SecurityAdvisories/zipball/c3c55a0f6643119fa8699577cc83ca6256d98ab5", - "reference": "c3c55a0f6643119fa8699577cc83ca6256d98ab5", + "url": "https://api.github.com/repos/Roave/SecurityAdvisories/zipball/2db4b93f047a03be06ec0a890d252e1c8c635f74", + "reference": "2db4b93f047a03be06ec0a890d252e1c8c635f74", "shasum": "" }, "conflict": { "3f/pygmentize": "<1.2", - "admidio/admidio": "<4.3.10", + "admidio/admidio": "<4.3.12", "adodb/adodb-php": "<=5.20.20|>=5.21,<=5.21.3", "aheinze/cockpit": "<2.2", "aimeos/ai-admin-graphql": ">=2022.04.1,<2022.10.10|>=2023.04.1,<2023.10.6|>=2024.04.1,<2024.04.6", @@ -6469,7 +6469,7 @@ "rap2hpoutre/laravel-log-viewer": "<0.13", "react/http": ">=0.7,<1.9", "really-simple-plugins/complianz-gdpr": "<6.4.2", - "redaxo/source": "<=5.15.1", + "redaxo/source": "<=5.17.1", "remdex/livehelperchat": "<4.29", "reportico-web/reportico": "<=8.1", "rhukster/dom-sanitizer": "<1.0.7", @@ -6543,7 +6543,7 @@ "subhh/libconnect": "<7.0.8|>=8,<8.1", "sukohi/surpass": "<1", "sulu/form-bundle": ">=2,<2.5.3", - "sulu/sulu": "<1.6.44|>=2,<2.6.5", + "sulu/sulu": "<1.6.44|>=2,<2.5.21|>=2.6,<2.6.5", "sumocoders/framework-user-bundle": "<1.4", "superbig/craft-audit": "<3.0.2", "swag/paypal": "<5.4.4", @@ -6773,7 +6773,7 @@ "type": "tidelift" } ], - "time": "2024-10-11T18:06:00+00:00" + "time": "2024-10-18T15:05:15+00:00" }, { "name": "sebastian/cli-parser", @@ -6945,16 +6945,16 @@ }, { "name": "sebastian/comparator", - "version": "5.0.2", + "version": "5.0.3", "source": { "type": "git", "url": "https://github.com/sebastianbergmann/comparator.git", - "reference": "2d3e04c3b4c1e84a5e7382221ad8883c8fbc4f53" + "reference": "a18251eb0b7a2dcd2f7aa3d6078b18545ef0558e" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/2d3e04c3b4c1e84a5e7382221ad8883c8fbc4f53", - "reference": "2d3e04c3b4c1e84a5e7382221ad8883c8fbc4f53", + "url": "https://api.github.com/repos/sebastianbergmann/comparator/zipball/a18251eb0b7a2dcd2f7aa3d6078b18545ef0558e", + "reference": "a18251eb0b7a2dcd2f7aa3d6078b18545ef0558e", "shasum": "" }, "require": { @@ -6965,7 +6965,7 @@ "sebastian/exporter": "^5.0" }, "require-dev": { - "phpunit/phpunit": "^10.4" + "phpunit/phpunit": "^10.5" }, "type": "library", "extra": { @@ -7010,7 +7010,7 @@ "support": { "issues": "https://github.com/sebastianbergmann/comparator/issues", "security": "https://github.com/sebastianbergmann/comparator/security/policy", - "source": "https://github.com/sebastianbergmann/comparator/tree/5.0.2" + "source": "https://github.com/sebastianbergmann/comparator/tree/5.0.3" }, "funding": [ { @@ -7018,7 +7018,7 @@ "type": "github" } ], - "time": "2024-08-12T06:03:08+00:00" + "time": "2024-10-18T14:56:07+00:00" }, { "name": "sebastian/complexity", @@ -8121,21 +8121,21 @@ }, { "name": "webimpress/coding-standard", - "version": "1.3.2", + "version": "1.4.0", "source": { "type": "git", "url": "https://github.com/webimpress/coding-standard.git", - "reference": "710f71ac95d36d931e76b47132b599c39abfab11" + "reference": "6f6a1a90bd9e18fc8bee0660dd1d1ce68cf9fc53" }, "dist": { "type": "zip", - "url": "https://api.github.com/repos/webimpress/coding-standard/zipball/710f71ac95d36d931e76b47132b599c39abfab11", - "reference": "710f71ac95d36d931e76b47132b599c39abfab11", + "url": "https://api.github.com/repos/webimpress/coding-standard/zipball/6f6a1a90bd9e18fc8bee0660dd1d1ce68cf9fc53", + "reference": "6f6a1a90bd9e18fc8bee0660dd1d1ce68cf9fc53", "shasum": "" }, "require": { "php": "^7.3 || ^8.0", - "squizlabs/php_codesniffer": "^3.7.2" + "squizlabs/php_codesniffer": "^3.10.3" }, "require-dev": { "phpunit/phpunit": "^9.6.15" @@ -8164,7 +8164,7 @@ ], "support": { "issues": "https://github.com/webimpress/coding-standard/issues", - "source": "https://github.com/webimpress/coding-standard/tree/1.3.2" + "source": "https://github.com/webimpress/coding-standard/tree/1.4.0" }, "funding": [ { @@ -8172,7 +8172,7 @@ "type": "github" } ], - "time": "2023-12-18T07:25:41+00:00" + "time": "2024-10-16T06:55:17+00:00" } ], "aliases": [], From bd6bad26a4c0b9af9877fccf422368a71c168e04 Mon Sep 17 00:00:00 2001 From: Jurj-Bogdan Date: Mon, 21 Oct 2024 22:36:37 +0300 Subject: [PATCH 3/6] Instructions for adding blog posts (issue 197) Signed-off-by: Jurj-Bogdan --- ADD_BLOG_ENTRY.md | 76 +++++++++++++++++++++++++++++++++++++++++++++++ README.md | 4 +++ 2 files changed, 80 insertions(+) create mode 100644 ADD_BLOG_ENTRY.md diff --git a/ADD_BLOG_ENTRY.md b/ADD_BLOG_ENTRY.md new file mode 100644 index 00000000..46adbf6b --- /dev/null +++ b/ADD_BLOG_ENTRY.md @@ -0,0 +1,76 @@ +## Adding a blog entry + +Blog entries can be added by following these steps: + +- If submitting for the first time an [author](#blog-author) YAML file must be added to the `data/blog/authors` directory. +- Add an MD file containing the [blog post's metadata and body](#blog-post-content). + - each file must be added in the current year's directory. + +> All submissions must follow the [contributing guidelines](https://github.com/laminas/.github/blob/main/CONTRIBUTING.md) as well as the [Code of Conduct](https://github.com/laminas/.github/blob/main/CODE_OF_CONDUCT.md) + +### Blog post content + +Each blog post **must** begin with the YAML section found in the [template](#template-of-blog-yaml-section). + +The `` tag is used to mark a preview section of the blog post on the listing page, with all following content being hidden. + +> **Note** that markdown and yaml files are linted as part of the repository's continuous integration pipeline. + +### Blog author + +The necessary author YAML file uses the following fields: + +- #### `id` **required** + + **string** - used internally, file name **must** match the given id. + +- #### `email` **required** + + **string** - to be displayed in RSS feeds. + +- #### `uri` **required** + + **string** - to be added to the author's name on the blog post's page. + +- #### `name` + + **string** - displayed name; if missing, a default value will be shown. + +#### Template of blog YAML section + +```yaml +--- +id: 2024-10-22-example-id +author: example-author-id +title: 'Example post title' +draft: true +public: true +created: '2024-10-22T11:00:00-01:00' +updated: '2024-10-22T11:00:00-01:00' +tags: + - example tag + - second example tag +--- +``` + +#### Blog entry metadata explained + +All the following fields are **required**: + +- `id` **string** - must be a unique identifier for the blog + + _By convention the date of submission is used as a prefix, using the `Y-m-d` format._ + +- `author` **(string)** - the `id` of the author, as set in the corresponding YAML file + +- `title` **(string)** - non-empty string used as the title of the post + +- `draft` **(boolean)** - the status of the blogpost, defaulting to `false`; if set to `true`, the post is hidden + +- `public` **(boolean)** - the visibility of the post, defaulting to `false`; if set to `true`, the post is visible on the listing page and feed + +- `created` **(string)** - must be a valid Date and Time format; used by default to sort the posts + +- `updated` **(string)** - must be a valid Date and Time format + +- `tags` **(array of strings)** - used to filter blog posts by tag diff --git a/README.md b/README.md index 42e02f10..4a140671 100644 --- a/README.md +++ b/README.md @@ -79,3 +79,7 @@ container: ```bash $ docker-compose build php ``` + +## Adding blog entries + +Blog posts can be submitted by following the process described [here](ADD_BLOG_ENTRY.md) From 8b406b9bc84c3922f43858a0235aa30a084573d9 Mon Sep 17 00:00:00 2001 From: Jurj-Bogdan Date: Tue, 22 Oct 2024 10:39:03 +0300 Subject: [PATCH 4/6] added documentation link to website (issue 197) Signed-off-by: Jurj-Bogdan --- ADD_BLOG_ENTRY.md | 2 +- src/Blog/templates/list.phtml | 3 +++ 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/ADD_BLOG_ENTRY.md b/ADD_BLOG_ENTRY.md index 46adbf6b..21c3e005 100644 --- a/ADD_BLOG_ENTRY.md +++ b/ADD_BLOG_ENTRY.md @@ -4,7 +4,7 @@ Blog entries can be added by following these steps: - If submitting for the first time an [author](#blog-author) YAML file must be added to the `data/blog/authors` directory. - Add an MD file containing the [blog post's metadata and body](#blog-post-content). - - each file must be added in the current year's directory. + - each file must be added in the current year's directory, found in `data/blog/`. > All submissions must follow the [contributing guidelines](https://github.com/laminas/.github/blob/main/CONTRIBUTING.md) as well as the [Code of Conduct](https://github.com/laminas/.github/blob/main/CODE_OF_CONDUCT.md) diff --git a/src/Blog/templates/list.phtml b/src/Blog/templates/list.phtml index 08e738a2..aa6293a8 100644 --- a/src/Blog/templates/list.phtml +++ b/src/Blog/templates/list.phtml @@ -65,4 +65,7 @@ $this->end(); insert('partials::pagination', ['pagination' => $pagination]) ?> + + Submit a blog post by following these instructions. + From 4927aae9abf4b9678f6c89eff9f6e18750270d04 Mon Sep 17 00:00:00 2001 From: Jurj-Bogdan Date: Thu, 24 Oct 2024 15:56:17 +0300 Subject: [PATCH 5/6] added examples and extra details Signed-off-by: Jurj-Bogdan --- ADD_BLOG_ENTRY.md | 75 ++++++++++++++++++++++++++++++++++++++--------- README.md | 5 +++- 2 files changed, 65 insertions(+), 15 deletions(-) diff --git a/ADD_BLOG_ENTRY.md b/ADD_BLOG_ENTRY.md index 21c3e005..afad4f01 100644 --- a/ADD_BLOG_ENTRY.md +++ b/ADD_BLOG_ENTRY.md @@ -1,42 +1,52 @@ -## Adding a blog entry +# Adding a blog entry Blog entries can be added by following these steps: -- If submitting for the first time an [author](#blog-author) YAML file must be added to the `data/blog/authors` directory. +- If submitting for the first time, an [author](#blog-author) YAML file must be added to the `data/blog/authors` directory. - Add an MD file containing the [blog post's metadata and body](#blog-post-content). - - each file must be added in the current year's directory, found in `data/blog/`. + - blog post files are named following a `yyyy-mm-dd-title` convention, e.g., `2024-10-24-blog-title.md` + - each file must be added to the appropriate year's directory, found in `data/blog/` + - use the following command to make sure your submission will be correctly built: +```bash +composer build-blog +``` + +- When ready, submit the blog post for review via pull request to the default branch. + +> You can use the [file examples](#file-examples) as starting point +> > All submissions must follow the [contributing guidelines](https://github.com/laminas/.github/blob/main/CONTRIBUTING.md) as well as the [Code of Conduct](https://github.com/laminas/.github/blob/main/CODE_OF_CONDUCT.md) -### Blog post content +## Blog post content Each blog post **must** begin with the YAML section found in the [template](#template-of-blog-yaml-section). The `` tag is used to mark a preview section of the blog post on the listing page, with all following content being hidden. -> **Note** that markdown and yaml files are linted as part of the repository's continuous integration pipeline. +> **Note** that markdown and yaml files should be linted. -### Blog author +## Blog author The necessary author YAML file uses the following fields: -- #### `id` **required** +- ### `id` **required** **string** - used internally, file name **must** match the given id. -- #### `email` **required** +- ### `email` **required** **string** - to be displayed in RSS feeds. -- #### `uri` **required** +- ### `uri` **required** **string** - to be added to the author's name on the blog post's page. -- #### `name` +- ### `name` **string** - displayed name; if missing, a default value will be shown. -#### Template of blog YAML section +### Template of blog YAML section ```yaml --- @@ -53,13 +63,13 @@ tags: --- ``` -#### Blog entry metadata explained +### Blog entry metadata explained All the following fields are **required**: - `id` **string** - must be a unique identifier for the blog - _By convention the date of submission is used as a prefix, using the `Y-m-d` format._ + _By convention the date of submission is used as a prefix, using the `yyyy-mm-dd` format._ - `author` **(string)** - the `id` of the author, as set in the corresponding YAML file @@ -73,4 +83,41 @@ All the following fields are **required**: - `updated` **(string)** - must be a valid Date and Time format -- `tags` **(array of strings)** - used to filter blog posts by tag +- `tags` **(array of strings)** - used to filter blog posts by tag + +### File examples + +#### author.yml + +```yaml +id: author +name: Sample Author +email: sampleAuthor@example.com +uri: 'https://example.com' + +``` + +#### 2024-10-24-blog-post-example.md + +```markdown +--- +id: 2024-10-24-example-post +author: author +title: 'Example post' +draft: false +public: true +created: '2024-10-24' +updated: '2024-10-24' +tags: + - example tag +--- + +Section above extended tag, which will be visible in the post list. + + + +## Sample heading + +Section below extended tag will be hidden in the listing, being visible only on the post's own page. + +``` diff --git a/README.md b/README.md index 4a140671..a58e03b7 100644 --- a/README.md +++ b/README.md @@ -82,4 +82,7 @@ $ docker-compose build php ## Adding blog entries -Blog posts can be submitted by following the process described [here](ADD_BLOG_ENTRY.md) +Everyone is welcome to post a blog entry. Once submitted, it will be reviewed by our team and approved to go live or rejected. +If it's rejected, the reason for the rejection will be included, so you can update it and resubmit the post if applicable. + +The submission process is described in the [ADD_BLOG_ENTRY](ADD_BLOG_ENTRY.md) file. From 97a82e9d5a5ea1d14d24d60c15279f797234f74d Mon Sep 17 00:00:00 2001 From: Aleksei Khudiakov Date: Fri, 25 Oct 2024 20:02:44 +1000 Subject: [PATCH 6/6] Provide github token to gh cli in workflow Signed-off-by: Aleksei Khudiakov --- .github/workflows/pr-autocloser.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/pr-autocloser.yml b/.github/workflows/pr-autocloser.yml index 4861fece..19bc17f7 100644 --- a/.github/workflows/pr-autocloser.yml +++ b/.github/workflows/pr-autocloser.yml @@ -15,3 +15,6 @@ jobs: run: | gh pr close "${{ github.event.pull_request.url }}" --comment "Pull requests to the live branch are not allowed. Use staging branch. Publish via workflow dispatch to Publish to live workflow" + env: + GH_TOKEN: ${{ secrets.GITHUB_TOKEN }} +