Skip to content
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.

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

Adds Pendulum 1.x -> 2.x upgrade documentation #18955

Merged
merged 3 commits into from
Oct 14, 2021
Merged

Conversation

1nF0rmed
Copy link
Contributor

closes: #18634

Adds documentation about the upgrade from Pendulum 1.x to 2.x as discussed in the issue.

Assumptions that were made:

  • Most of the Pendulum changes are already documented in the official Pendulum docs.

Added the following:

  • Mention the upgrade from 1.x to 2.x
  • Added an example of a code snippet that will now throw errors
  • Added link to official pendulum 2.x docs that discuss the changes from 1.x to 2.x

The macros documentation as mentioned in the issue were actually pointing to the updated Pendulum documentation, so no changes were added for the same. For instance, consider the link for the macro prev_execution_date

As it was a documentation update, didn't run any tests.

@boring-cyborg
Copy link

boring-cyborg bot commented Oct 13, 2021

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 Contribution Guide (https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst)
Here are some useful points:

  • Pay attention to the quality of your code (flake8, 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.
    Apache Airflow is a community-driven project and together we are making it better 🚀.
    In case of doubts contact the developers at:
    Mailing List: [email protected]
    Slack: https://s.apache.org/airflow-slack

@1nF0rmed 1nF0rmed requested a review from kaxil October 13, 2021 18:00
@github-actions github-actions bot added the okay to merge It's ok to merge this PR as it does not require more tests label Oct 13, 2021
@github-actions
Copy link

The PR is likely ready to be merged. No tests are needed as no important environment files, nor python files were modified by it. However, committers might decide that full test matrix is needed and add the 'full tests needed' label. Then you should rebase it to the latest main or amend the last commit of the PR, and push it with --force-with-lease.

@kaxil
Copy link
Member

kaxil commented Oct 13, 2021

Static check is failing

@kaxil kaxil merged commit 141d9f2 into apache:main Oct 14, 2021
@boring-cyborg
Copy link

boring-cyborg bot commented Oct 14, 2021

Awesome work, congrats on your first merged pull request!

potiuk pushed a commit that referenced this pull request Jan 23, 2022
closes: #18634

Adds documentation about the upgrade from Pendulum `1.x` to `2.x` as discussed in the issue.

Assumptions that were made:

- Most of the Pendulum changes are already documented in the official Pendulum docs.

Added the following:

- Mention the upgrade from `1.x` to `2.x`
- Added an example of a code snippet that will now throw errors
- Added link to official pendulum `2.x` docs that discuss the changes from `1.x` to `2.x`

The macros documentation as mentioned in the issue were actually pointing to the updated Pendulum documentation, so no changes were added for the same. For instance, consider the link for the macro [prev_execution_date](https://pendulum.eustace.io/docs/#introduction)

(cherry picked from commit 141d9f2)
@potiuk potiuk added the type:doc-only Changelog: Doc Only label Jan 23, 2022
@potiuk potiuk added this to the Airflow 2.2.4 milestone Jan 23, 2022
jedcunningham pushed a commit that referenced this pull request Jan 27, 2022
closes: #18634

Adds documentation about the upgrade from Pendulum `1.x` to `2.x` as discussed in the issue.

Assumptions that were made:

- Most of the Pendulum changes are already documented in the official Pendulum docs.

Added the following:

- Mention the upgrade from `1.x` to `2.x`
- Added an example of a code snippet that will now throw errors
- Added link to official pendulum `2.x` docs that discuss the changes from `1.x` to `2.x`

The macros documentation as mentioned in the issue were actually pointing to the updated Pendulum documentation, so no changes were added for the same. For instance, consider the link for the macro [prev_execution_date](https://pendulum.eustace.io/docs/#introduction)

(cherry picked from commit 141d9f2)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind:documentation okay to merge It's ok to merge this PR as it does not require more tests type:doc-only Changelog: Doc Only
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Pendulum 1.x -> 2.x with Airflow 1.x -> 2.x Documentation Updates
3 participants