Skip to content
Open
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
2 changes: 1 addition & 1 deletion .github/workflows/pelican-action-test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a grammar error that I tripped on while looking at this workflow failure

runs-on: ubuntu-latest
concurrency: # target must not be updated by two jobs at once
group: testsite-${{ github.ref_name }} # must agree with TARGET
Expand Down
2 changes: 1 addition & 1 deletion pelican/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ASF Infrastructure Pelican Action

**Note** This Action simplifies managing a project website. More information is available at <a href="https://infra.apache.org/asf-pelican.html" targeet="_blank">infra.apache.org/asf-pelican.html</a>.
**Note** This Action simplifies managing a project website. More information is available at <a href="https://infra.apache.org/asf-pelican.html" target="_blank">infra.apache.org/asf-pelican.html</a>.

## Inputs
* destination Pelican Output branch (optional) default: asf-site
Expand Down
2 changes: 1 addition & 1 deletion pelican/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
10 changes: 5 additions & 5 deletions pelican/migration/generate_settings.py
Original file line number Diff line number Diff line change
Expand Up @@ -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
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

there's nothing horribly wrong w/ using short names, but there didn't seem to be a particularly good reason for it either.

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()
2 changes: 1 addition & 1 deletion pelican/plugin_paths.py
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typos otoh ...

# 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 = { }
Expand Down
2 changes: 1 addition & 1 deletion pelican/plugins/PLUGIN_ARCH.md
Original file line number Diff line number Diff line change
@@ -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.
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is an accessibility issue:

Do not use (click) here links

For more information, see:

(?i)(?:>|\[)(?:(?:click |)here|link|(?:read |)more)(?:</|\]\()

it'd be really nice if Apache as a best practice blocked people from using (click) here links...

At a high level consider the following sequence of events:

1. Pelican Settings. Settings for a Pelican Build are in your Pelican Configuration
Expand Down
2 changes: 1 addition & 1 deletion pelican/plugins/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
4 changes: 2 additions & 2 deletions pelican/plugins/asfdata.py
Original file line number Diff line number Diff line change
Expand Up @@ -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]
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion pelican/plugins/asfindex.py
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion pelican/plugins/asfreader.py
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion stash/restore/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion stash/save/action.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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; }
Expand Down
Loading