This is an automated email from the ASF dual-hosted git repository. abderrahim pushed a commit to branch preview/pelican-migration in repository https://gitbox.apache.org/repos/asf/buildstream-site.git
commit db4877b5b70c2a7983a00e618ca0294fe27fbbc6 Author: Abderrahim Kitouni <[email protected]> AuthorDate: Sun Jul 12 11:00:06 2026 +0100 Migrate to pelican github action --- .github/workflows/build-pelican.yml | 39 ++++++++++++++++ pelicanconf.py | 89 +++++++++++++++++++++++++++++++++++++ 2 files changed, 128 insertions(+) diff --git a/.github/workflows/build-pelican.yml b/.github/workflows/build-pelican.yml new file mode 100644 index 0000000..dbb912c --- /dev/null +++ b/.github/workflows/build-pelican.yml @@ -0,0 +1,39 @@ +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +name: Build a Pelican Website +on: + push: + # This prevents the workflow from running automatically on a new branch + # When creating a new site branch, please ensure that the push and checkout branches agree + # and that the action/pelican destination value is updated accordingly + branches: [ 'main' ] + workflow_dispatch: +jobs: + build-pelican: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v4 + with: + # This must equal the push/branches list above, and be appropriate for the destination below + ref: 'main' + - uses: apache/infrastructure-actions/pelican@main + with: + # This must be appropriate for the branch being built + destination: 'asf-site' + gfm: 'true' diff --git a/pelicanconf.py b/pelicanconf.py new file mode 100644 index 0000000..9a25cb7 --- /dev/null +++ b/pelicanconf.py @@ -0,0 +1,89 @@ + +# +# Licensed to the Apache Software Foundation (ASF) under one +# or more contributor license agreements. See the NOTICE file +# distributed with this work for additional information +# regarding copyright ownership. The ASF licenses this file +# to you under the Apache License, Version 2.0 (the +# "License"); you may not use this file except in compliance +# with the License. You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, +# software distributed under the License is distributed on an +# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY +# KIND, either express or implied. See the License for the +# specific language governing permissions and limitations +# under the License. +# +import datetime +# Basic information about the site. +SITENAME = 'Apache BuildStream' +SITEDESC = 'BuildStream, the software integration tool' +SITEDOMAIN = 'buildstream.apache.org' +SITEURL = 'https://buildstream.apache.org' +SITELOGO = 'https://buildstream.apache.org/images/logo.png' +SITEREPOSITORY = 'https://github.com/apache/buildstream-site/blob/HEAD/content' +CURRENTYEAR = datetime.date.today().year +TRADEMARKS = 'Apache, the Apache feather logo, and BuildStream are trademarks or registered trademarks' +TIMEZONE = 'UTC' +# Theme includes templates and possibly static files +THEME = 'content/theme' +# Specify location of plugins, and which to use +PLUGIN_PATHS = [ 'plugins', ] +# If the website uses any *.ezmd files, include the 'gfm' and 'asfreader' plugins (in that order) +PLUGINS = [ 'toc', 'spu', 'gfm', 'asfgenid', ] +# All content is located at '.' (aka content/ ) +PAGE_PATHS = [ 'pages' ] +STATIC_PATHS = [ '.', ] +# Where to place/link generated pages + +PATH_METADATA = 'pages/(?P<path_no_ext>.*)\\..*' + +PAGE_SAVE_AS = '{path_no_ext}.html' +# Don't try to translate +PAGE_TRANSLATION_ID = None +# Disable unused Pelican features +# N.B. These features are currently unsupported, see https://github.com/apache/infrastructure-pelican/issues/49 +FEED_ALL_ATOM = None +INDEX_SAVE_AS = '' +TAGS_SAVE_AS = '' +CATEGORIES_SAVE_AS = '' +AUTHORS_SAVE_AS = '' +ARCHIVES_SAVE_AS = '' +# Disable articles by pointing to a (should-be-absent) subdir +ARTICLE_PATHS = [ 'blog' ] +# needed to create blogs page +ARTICLE_URL = 'blog/{slug}.html' +ARTICLE_SAVE_AS = 'blog/{slug}.html' +# Disable all processing of .html files +READERS = { 'html': None, } + +# Configure the asfgenid plugin +ASF_GENID = { + 'unsafe_tags': True, + 'metadata': False, + 'elements': False, + 'permalinks': False, + 'tables': False, + + 'headings': False, + + + 'toc': False, + + 'debug': False, +} + + + + + + +# Configure ignore files +# File and directory basenames matching any of these patterns will be ignored by the processor. +IGNORE_FILES = [ 'theme', ] + + +
