potiuk commented on code in PR #65629:
URL: https://github.com/apache/airflow/pull/65629#discussion_r3126418522
##########
dev/MANUALLY_GENERATING_IMAGE_CACHE_AND_CONSTRAINTS.md:
##########
@@ -279,13 +279,15 @@ This is a step-by-step instruction on how to use it:
1. You need to have "airflow" repository checked out separately from the
repository you are working on. For
example in `/home/myuser/airflow-constraints` folder.
2. You need to checkout `constraints-main` branch in this repository. By
default the command expects that
- there is a remote named "apache" pointing to the official Apache
repository. You can override this
- by passing `--remote-name` option to the command.
+ there is a remote named "upstream" pointing to the `apache/airflow`
repository (the standard remote
+ naming convention — see
+
[`contributing-docs/10_working_with_git.rst`](../contributing-docs/10_working_with_git.rst#git-remote-naming-conventions)).
+ You can override this by passing `--remote-name` option to the command.
3. You need to run `breeze release-management update-constraints` command. The
`breeze` command comes usually
Review Comment:
Applied option 1 ("Typically, `breeze` is run from a separate clone of the
Airflow repository, on the `main` branch.") in 475f8fff64 — thanks!
##########
contributing-docs/10_working_with_git.rst:
##########
@@ -139,30 +177,30 @@ First of all, we suggest you read about the rebase
workflow here:
`Merging vs. rebasing
<https://www.atlassian.com/git/tutorials/merging-vs-rebasing>`_. This is an
excellent article that describes all the ins/outs of the rebase workflow. I
recommend keeping it for future reference.
-The goal of rebasing your PR on top of ``apache/main`` is to "transplant" your
change on top of
+The goal of rebasing your PR on top of ``upstream/main`` is to "transplant"
your change on top of
the latest changes that are merged by others. It also allows you to fix all
the conflicts
-that arise as a result of other people changing the same files as you and
merging the changes to ``apache/main``.
+that arise as a result of other people changing the same files as you and
merging the changes to ``upstream/main``.
Here is how rebase looks in practice (you can find a summary below these
detailed steps):
1. You first need to add the Apache project remote to your git repository.
This is only necessary once,
-so if it's not the first time you are following this tutorial you can skip
this step. In this example,
-we will be adding the remote as "apache" so you can refer to it easily
+so if it's not the first time you are following this tutorial you can skip
this step. Per the
+`Git remote naming conventions`_ we add it as ``upstream``:
-* If you use ssh: ``git remote add apache [email protected]:apache/airflow.git``
-* If you use https: ``git remote add apache
https://github.com/apache/airflow.git``
+* If you use ssh: ``git remote add upstream
[email protected]:apache/airflow.git``
+* If you use https: ``git remote add upstream
https://github.com/apache/airflow.git``
Review Comment:
Indented the wrapped paragraph and both bullets under step 1 to 3 spaces so
the list renders correctly in Sphinx. Fixed in 475f8fff64.
##########
dev/breeze/src/airflow_breeze/commands/sbom_commands.py:
##########
@@ -198,11 +198,15 @@ def sbom_group():
)
@click.option(
"--remote-name",
- type=NotVerifiedBetterChoice(["apache", "origin"]),
- default="apache",
+ type=NotVerifiedBetterChoice(["upstream", "origin"]),
+ default="upstream",
show_default=True,
Review Comment:
Good point — kept `apache` in the `NotVerifiedBetterChoice` list for
autocomplete/`--help` discoverability during the transition, with a code
comment noting why. Runtime acceptance of arbitrary values is unchanged.
475f8fff64.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
