Skip to content

Conversation

@geovalexis
Copy link
Contributor

The command line used for replacing newlines with literal \n was not working for MacOS. The problem was that the regex is prepared to match newlines of Windows type but not for Unix-type newlines (without carriage return:\r). By adding a ?("zero or one occurrence" quantifier) in between the \r and \n, we match not only Windows but also MacOS/Unix newlines.

In summary:

  • On Windows, newlines are \r\n (carriage return + newline).
  • On Linux/MacOS, newlines are just \n (no \r).
  • \r?\n ensures that both types are matched and replaced correctly.

This command has been tested in both MacOS (Sequoia) and Windows 11 (using WSL2 > Ubuntu 22.04)


^ Add meaningful description above
Read the Pull Request Guidelines for more information.
In case of fundamental code changes, an Airflow Improvement Proposal (AIP) is needed.
In case of a new dependency, check compliance with the ASF 3rd Party License Policy.
In case of backwards incompatible changes please leave a note in a newsfragment file, named {pr_number}.significant.rst or {issue_number}.significant.rst, in newsfragments.

…tor` docs

Old command only worked for Windows users but not for MAC nor Linux users. This new command works for all users.
@boring-cyborg
Copy link

boring-cyborg bot commented Mar 7, 2025

Congratulations on your first Pull Request and welcome to the Apache Airflow community! If you have any issues or are unsure about any anything please check our Contributors' Guide (https://github.com/apache/airflow/blob/main/contributing-docs/README.rst)
Here are some useful points:

  • Pay attention to the quality of your code (ruff, mypy and type annotations). Our pre-commits will help you with that.
  • In case of a new feature add useful documentation (in docstrings or in docs/ directory). Adding a new operator? Check this short guide Consider adding an example DAG that shows how users should use it.
  • Consider using Breeze environment for testing locally, it's a heavy docker but it ships with a working Airflow and a lot of integrations.
  • Be patient and persistent. It might take some time to get a review or get the final approval from Committers.
  • Please follow ASF Code of Conduct for all communication including (but not limited to) comments on Pull Requests, Mailing list and Slack.
  • Be sure to read the Airflow Coding style.
  • Always keep your Pull Requests rebased, otherwise your build might fail due to changes not related to your commits.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: dev@airflow.apache.org
    Slack: https://s.apache.org/airflow-slack

@geovalexis geovalexis changed the title Fix/ssh operator docs Update command for replacing newlines with literals \n in SSHOperator docs Mar 7, 2025
@geovalexis geovalexis changed the title Update command for replacing newlines with literals \n in SSHOperator docs Update command for replacing newlines with literals \n in SSHOperator docs Mar 7, 2025
@geovalexis geovalexis changed the title Update command for replacing newlines with literals \n in SSHOperator docs Make command for replacing newlines with literals \n in SSHOperatorconnection MacOs/Linux compatible Mar 7, 2025
@potiuk potiuk merged commit 2a63b47 into apache:main Mar 7, 2025
41 checks passed
@boring-cyborg
Copy link

boring-cyborg bot commented Mar 7, 2025

Awesome work, congrats on your first merged pull request! You are invited to check our Issue Tracker for additional contributions.

nailo2c pushed a commit to nailo2c/airflow that referenced this pull request Apr 4, 2025
…r`connection MacOs/Linux compatible (apache#47491)

* Update command for replacing newlines with literals `\n` in `SSHOperator` docs

Old command only worked for Windows users but not for MAC nor Linux users. This new command works for all users.

* remove raw string prefix from regex pattern to avoid more changes than needed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants