From a83964c11b93e07dad895f4ae93b61a3333a5e3d Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 5 Feb 2025 12:37:58 -0500 Subject: [PATCH 01/11] spelling: alphabetization Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- pelican/plugins/asfdata.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pelican/plugins/asfdata.py b/pelican/plugins/asfdata.py index db3d7b2e..9b0a9b6a 100644 --- a/pelican/plugins/asfdata.py +++ b/pelican/plugins/asfdata.py @@ -113,7 +113,7 @@ def where_parts(reference, part): del reference[refs] -# perform alphabetation. HTTP Server is special and is put before 'A' +# perform alphabetization. HTTP Server is special and is put before 'A' def alpha_part(reference, part): for refs in reference: name = reference[refs][part] From 6f960379d4ce7de9577d63b69af7421979f44d62 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 5 Feb 2025 12:31:59 -0500 Subject: [PATCH 02/11] spelling: attributes Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- pelican/plugins/asfdata.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pelican/plugins/asfdata.py b/pelican/plugins/asfdata.py index 9b0a9b6a..f07ff761 100644 --- a/pelican/plugins/asfdata.py +++ b/pelican/plugins/asfdata.py @@ -160,7 +160,7 @@ def add_logo(reference, part): def sequence_dict(seq, reference): sequence = [ ] for refs in reference: - # converting dicts into objects with attrributes. Ignore non-dict content. + # converting dicts into objects with attributes. Ignore non-dict content. if isinstance(reference[refs], dict): # put the key of the dict into the dictionary reference[refs]['key_id'] = refs From 0b5090d69159b4baa9a058a9bfe94c932991abef Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 5 Feb 2025 12:35:49 -0500 Subject: [PATCH 03/11] spelling: branch Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- stash/restore/action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/stash/restore/action.yml b/stash/restore/action.yml index b88be8f5..50cb8267 100644 --- a/stash/restore/action.yml +++ b/stash/restore/action.yml @@ -43,7 +43,7 @@ inputs: only-current-branch: description: > If true, only the current branch will be searched for the stash. - If false, the base branch(PRs)/default branch branch will be searched as well. + If false, the base branch(PRs)/default branch will be searched as well. default: "false" outputs: stash-hit: From 6c4656f8d7abce599c3a9cb5b1f1a1b89071cac5 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 5 Feb 2025 12:36:10 -0500 Subject: [PATCH 04/11] spelling: check Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- stash/save/action.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/stash/save/action.yml b/stash/save/action.yml index 1ee8c818..c68aa7ed 100644 --- a/stash/save/action.yml +++ b/stash/save/action.yml @@ -102,7 +102,7 @@ outputs: runs: using: 'composite' steps: - - name: Check Check for dependencies + - name: Check for dependencies shell: bash run: | type -P python3 > /dev/null 2>&1 || { echo "::error ::python3 is required for this action"; exit 1; } From 1d24f1d7dae922194016ef10c8f35f5ede930ea7 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 5 Feb 2025 12:38:13 -0500 Subject: [PATCH 05/11] spelling: current Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- pelican/plugins/asfindex.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pelican/plugins/asfindex.py b/pelican/plugins/asfindex.py index 87200a40..1fda857d 100644 --- a/pelican/plugins/asfindex.py +++ b/pelican/plugins/asfindex.py @@ -102,7 +102,7 @@ def get_index(site_index, scope): # get site menu # def get_menu(site_index, menus): -# currrent_menu = None +# current_menu = None # site_menu = '' # if menus: # for f in menus: From 8191c43bab07d415d57e65dccba007c451ad64bd Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 5 Feb 2025 12:32:50 -0500 Subject: [PATCH 06/11] spelling: extensions Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- pelican/plugins/asfreader.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pelican/plugins/asfreader.py b/pelican/plugins/asfreader.py index 9ac0c61a..3a5daa41 100644 --- a/pelican/plugins/asfreader.py +++ b/pelican/plugins/asfreader.py @@ -114,7 +114,7 @@ def read(self, source_path): # The following are required or ezmd files are not read instead they are static. # For direct subclasses of BaseReader like GFMReader the following two -# callables are optional if the class includes enabled=True and file_extenaions. +# callables are optional if the class includes enabled=True and file_extensions. def add_readers(readers): readers.reader_classes['ezmd'] = ASFReader From 8289360f35e851139bd7d214c93ed8abcaba8722 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 5 Feb 2025 12:35:18 -0500 Subject: [PATCH 07/11] spelling: github Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- pelican/action.yml | 2 +- pelican/plugins/README.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/pelican/action.yml b/pelican/action.yml index 464870ea..dd0a6005 100644 --- a/pelican/action.yml +++ b/pelican/action.yml @@ -55,7 +55,7 @@ runs: pip3 list # This a long list fi - # If the site uses Github Flavored Markdown, use this build branch + # If the site uses GitHub Flavored Markdown, use this build branch - name: fetch and build libcmark-gfm.so if: ${{ inputs.gfm == 'true' }} shell: bash diff --git a/pelican/plugins/README.md b/pelican/plugins/README.md index b3d17ed8..68eef380 100644 --- a/pelican/plugins/README.md +++ b/pelican/plugins/README.md @@ -25,7 +25,7 @@ During initiation, runs scripts that can be used to create content and static fi ## gfm -Pelican plugin that processes Github Flavored Markdown (**GFM**) using the cmark library. +Pelican plugin that processes GitHub Flavored Markdown (**GFM**) using the cmark library. ## toc From 430f9db100da6668ed3f6af44fc22a346e7ecef1 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 5 Feb 2025 12:39:11 -0500 Subject: [PATCH 08/11] spelling: pelicanconf Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- pelican/migration/generate_settings.py | 10 +++++----- pelican/plugin_paths.py | 2 +- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/pelican/migration/generate_settings.py b/pelican/migration/generate_settings.py index 4af91a0a..fd4508de 100644 --- a/pelican/migration/generate_settings.py +++ b/pelican/migration/generate_settings.py @@ -179,15 +179,15 @@ def main(): parser.add_argument('-y', '--yaml', required=True, help="Pelicanconf YAML file") args = parser.parse_args() - pelconf_yaml = args.yaml - sourcepath = os.path.dirname(os.path.realpath(pelconf_yaml)) + pelicanconf_yaml = args.yaml + sourcepath = os.path.dirname(os.path.realpath(pelicanconf_yaml)) tool_dir = THIS_DIR - if os.path.exists(pelconf_yaml): - print(f"found {pelconf_yaml}") + if os.path.exists(pelicanconf_yaml): + print(f"found {pelicanconf_yaml}") settings_path = os.path.join(sourcepath, AUTO_SETTINGS) builtin_plugins = os.path.join(tool_dir, os.pardir, "plugins") - generate_settings(pelconf_yaml, settings_path, [builtin_plugins], sourcepath) + generate_settings(pelicanconf_yaml, settings_path, [builtin_plugins], sourcepath) if __name__ == "__main__": main() diff --git a/pelican/plugin_paths.py b/pelican/plugin_paths.py index 9c6084f4..a9dd830f 100755 --- a/pelican/plugin_paths.py +++ b/pelican/plugin_paths.py @@ -50,7 +50,7 @@ def main(): with open(file, 'r', encoding='utf-8') as infile: contents = infile.read() - # This will contain the "globals" after executing the peliconconf.py. + # This will contain the "globals" after executing the pelicanconf.py. # Note: allow all builtins (by virtue of NOT inserting a __builtins__ # value into this dictionary. We have no concerns about builtin usage. values = { } From 28c01f15b168bdb4809d26feb5b92bce6de0e567 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 5 Feb 2025 12:34:04 -0500 Subject: [PATCH 09/11] spelling: target Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- pelican/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pelican/README.md b/pelican/README.md index e7002425..f1cf326a 100644 --- a/pelican/README.md +++ b/pelican/README.md @@ -1,6 +1,6 @@ # ASF Infrastructure Pelican Action -**Note** This Action simplifies managing a project website. More information is available at infra.apache.org/asf-pelican.html. +**Note** This Action simplifies managing a project website. More information is available at infra.apache.org/asf-pelican.html. ## Inputs * destination Pelican Output branch (optional) default: asf-site From 53aee411e6f4f927d8444ca62d44fa6ddb7b33e1 Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 5 Feb 2025 12:36:45 -0500 Subject: [PATCH 10/11] link: signals Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- pelican/plugins/PLUGIN_ARCH.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pelican/plugins/PLUGIN_ARCH.md b/pelican/plugins/PLUGIN_ARCH.md index aef77318..8dd30823 100644 --- a/pelican/plugins/PLUGIN_ARCH.md +++ b/pelican/plugins/PLUGIN_ARCH.md @@ -1,7 +1,7 @@ # Plugin Architecture The plugins used operate at various points in a pelican build. -Pelican uses signals at various points. These are documented [here](https://docs.getpelican.com/en/latest/plugins.html#list-of-signals). +Pelican uses [signals](https://docs.getpelican.com/en/latest/plugins.html#list-of-signals) at various points. At a high level consider the following sequence of events: 1. Pelican Settings. Settings for a Pelican Build are in your Pelican Configuration From 9d140b88b6ce767db7d5318faa7c00bd07fe070f Mon Sep 17 00:00:00 2001 From: Josh Soref <2119212+jsoref@users.noreply.github.com> Date: Wed, 5 Feb 2025 12:57:15 -0500 Subject: [PATCH 11/11] spelling: its own Signed-off-by: Josh Soref <2119212+jsoref@users.noreply.github.com> --- .github/workflows/pelican-action-test.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/pelican-action-test.yml b/.github/workflows/pelican-action-test.yml index 3b6b3d35..bbc6393b 100644 --- a/.github/workflows/pelican-action-test.yml +++ b/.github/workflows/pelican-action-test.yml @@ -10,7 +10,7 @@ jobs: pelican-test: env: # source and target branches SOURCE: testsite - TARGET: testsite-${{ github.ref_name }} # each branch has own test output + TARGET: testsite-${{ github.ref_name }} # each branch has its own test output runs-on: ubuntu-latest concurrency: # target must not be updated by two jobs at once group: testsite-${{ github.ref_name }} # must agree with TARGET