Skip to content

Specify that the regexes are Python regexes and link to the Python docs #110

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.

Sign up for GitHub

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

Merged
yarikoptic merged 1 commit into from
Jun 14, 2021
Merged

Specify that the regexes are Python regexes and link to the Python docs #110

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
27 changes: 15 additions & 12 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -176,22 +176,22 @@ keys:

``include``
A list of workflows to retrieve assets for, given as either
basenames or (when ``regex`` is true) regular expressions to
match against basenames. If ``include`` is omitted, it
defaults to including all workflows.
basenames or (when ``regex`` is true) `Python regular
expressions`_ to match against basenames. If ``include`` is
omitted, it defaults to including all workflows.

``exclude``
A list of workflows to not retrieve assets for, given as either
basenames or (when ``regex`` is true) regular expressions to
match against basenames. If ``exclude`` is omitted, no
workflows are excluded. Workflows that match both ``include``
and ``exclude`` are excluded.
basenames or (when ``regex`` is true) `Python regular
expressions`_ to match against basenames. If ``exclude`` is
omitted, no workflows are excluded. Workflows that match both
``include`` and ``exclude`` are excluded.

``regex``
A boolean. If true (default false), the elements of the
``include`` and ``exclude`` fields are treated as regular
expressions that are matched (unanchored) against workflow
basenames; if false, they are used as exact names
``include`` and ``exclude`` fields are treated as `Python
regular expressions`_ that are matched (unanchored) against
workflow basenames; if false, they are used as exact names

When ``workflows`` is not specified, assets are retrieved for all
workflows in the repository.
Expand Down Expand Up @@ -269,8 +269,8 @@ keys:
A build in response to new commits

``secrets``
A mapping from names (used in log messages) to regexes matching secrets to
sanitize
A mapping from names (used in log messages) to `Python regular
expressions`_ matching secrets to sanitize

``allow-secrets-regex``
Any strings that match a ``secrets`` regex and also match this regex will
Expand All @@ -295,6 +295,9 @@ keys:

.. _DataLad: https://www.datalad.org

.. _Python regular expressions: https://docs.python.org/3/library/re.html
#regular-expression-syntax
Copy link
Copy Markdown
Member

@yarikoptic yarikoptic Jun 14, 2021

Choose a reason for hiding this comment

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

note to myself: tested in github README.rst renderer for the diff -- it manages to bring the #fragment properly into the url


A sample config file:

.. code:: yaml
Expand Down