This is an automated email from the ASF dual-hosted git repository.
potiuk pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/airflow.git
The following commit(s) were added to refs/heads/main by this push:
new eae6578ca53 feat(airflowctl): add first release notes and config.toml
for it (#54683)
eae6578ca53 is described below
commit eae6578ca53b3a8b29755ebb00d1059d2d409ee8
Author: Bugra Ozturk <[email protected]>
AuthorDate: Sun Aug 24 07:18:47 2025 +0200
feat(airflowctl): add first release notes and config.toml for it (#54683)
* feat(airflowctl): add first release notes and config.toml for it
* feat(airflowctl/docs) Update Airflow CTL with airflowctl
* feat(airflowctl/docs): fix docs and add docs path to boring-cyborg
* Update airflow-ctl/docs/installation/index.rst
Co-authored-by: GPK <[email protected]>
* feat(airflowctl/docs): update comments
* feat(breeze): update doc reference with stable link
* Update airflow-ctl/src/airflowctl/__main__.py
* Update airflow-ctl/src/airflowctl/__main__.py
---------
Co-authored-by: GPK <[email protected]>
---
.github/boring-cyborg.yml | 1 +
.../dependencies.rst => RELEASE_NOTES.rst} | 12 +--
airflow-ctl/docs/changelog.rst | 2 +-
airflow-ctl/docs/cli-and-env-variables-ref.rst | 2 +-
airflow-ctl/docs/conf.py | 2 +-
airflow-ctl/docs/howto/index.rst | 40 ++++-----
airflow-ctl/docs/index.rst | 4 +-
airflow-ctl/docs/installation/dependencies.rst | 2 +-
airflow-ctl/docs/installation/index.rst | 6 +-
.../docs/installation/installing-from-pypi.rst | 100 ---------------------
.../docs/installation/installing-from-sources.rst | 8 +-
airflow-ctl/docs/installation/prerequisites.rst | 6 +-
.../docs/installation/supported-versions.rst | 6 +-
airflow-ctl/docs/security.rst | 13 +--
airflow-ctl/docs/start.rst | 8 +-
airflow-ctl/newsfragments/config.toml | 50 +++++++++++
docs/spelling_wordlist.txt | 1 +
17 files changed, 107 insertions(+), 156 deletions(-)
diff --git a/.github/boring-cyborg.yml b/.github/boring-cyborg.yml
index 954ec6a9ac5..d90acc9a54d 100644
--- a/.github/boring-cyborg.yml
+++ b/.github/boring-cyborg.yml
@@ -357,6 +357,7 @@ labelPRBasedOnFilePath:
- providers/**/docs/**/*
- providers-summary-docs/**/*
- docker-stack-docs/**/*
+ - airflow-ctl/docs/**/*
area:helm-chart:
- chart/**/*
diff --git a/airflow-ctl/docs/installation/dependencies.rst
b/airflow-ctl/RELEASE_NOTES.rst
similarity index 75%
copy from airflow-ctl/docs/installation/dependencies.rst
copy to airflow-ctl/RELEASE_NOTES.rst
index 77d20b60907..6712c4c3bce 100644
--- a/airflow-ctl/docs/installation/dependencies.rst
+++ b/airflow-ctl/RELEASE_NOTES.rst
@@ -15,12 +15,8 @@
specific language governing permissions and limitations
under the License.
-Dependencies
-------------
+airflowctl 1.0.0b1 (2025-08-23)
+------------------------------
-Airflow CTL dependencies
-''''''''''''''''''''''''''
-
-The ``apache-airflow-ctl`` PyPI basic package only installs what's needed to
get started.
-Additional packages can be installed depending on what will be useful in your
-environment.
+Beta Release of airflowctl, a command-line tool. There are lots of great
features to use from start.
+Please check the documentation for quick start and usage instructions.
diff --git a/airflow-ctl/docs/changelog.rst b/airflow-ctl/docs/changelog.rst
index 50a8a3b7757..ad5096117aa 100644
--- a/airflow-ctl/docs/changelog.rst
+++ b/airflow-ctl/docs/changelog.rst
@@ -28,4 +28,4 @@ Changelog
1.0.0
.....
-Initial version of the Airflow CTL.
+Initial version of the airflowctl.
diff --git a/airflow-ctl/docs/cli-and-env-variables-ref.rst
b/airflow-ctl/docs/cli-and-env-variables-ref.rst
index db45a5d2e27..4d577eafb99 100644
--- a/airflow-ctl/docs/cli-and-env-variables-ref.rst
+++ b/airflow-ctl/docs/cli-and-env-variables-ref.rst
@@ -21,7 +21,7 @@ Command Line Interface and Environment Variables Reference
Command Line Interface
''''''''''''''''''''''
-Airflow CTL has a very rich command line interface that allows for
+airflowctl has a very rich command line interface that allows for
many types of operation on a DAG, starting services, and supporting
development and testing.
diff --git a/airflow-ctl/docs/conf.py b/airflow-ctl/docs/conf.py
index ef1ab197279..08f867ee43f 100644
--- a/airflow-ctl/docs/conf.py
+++ b/airflow-ctl/docs/conf.py
@@ -152,7 +152,7 @@ keep_warnings = True
# a list of builtin themes.
html_theme = "sphinx_airflow_theme"
-html_title = "Airflow CTL Documentation"
+html_title = "airflowctl Documentation"
# A shorter title for the navigation bar. Default is the same as html_title.
html_short_title = ""
diff --git a/airflow-ctl/docs/howto/index.rst b/airflow-ctl/docs/howto/index.rst
index f49f83204e1..da2088632b5 100644
--- a/airflow-ctl/docs/howto/index.rst
+++ b/airflow-ctl/docs/howto/index.rst
@@ -24,20 +24,20 @@ Setting up the sandbox in the :doc:`/start` section was
easy;
building a production-grade environment requires a bit more work!
These how-to guides will step you through common tasks in using and
-configuring an Airflow CTL environment.
+configuring an airflowctl environment.
-How to use Airflow CTL
+How to use airflowctl
----------------------
**Important Note**
''''''''''''''''''
-Airflow CTL needs the Airflow API running to be able to work. Please, see the
login section below before use.
+airflowctl needs the Airflow API running to be able to work. Please, see the
login section below before use.
Otherwise, you may get errors.
Login
'''''
-Airflow CTL needs to be able to connect to the Airflow API. You should pass
API URL as a parameter to the command
+airflowctl needs to be able to connect to the Airflow API. You should pass API
URL as a parameter to the command
``--api-url``. The URL should be in the form of ``http(s)://<host>:<port>``.
You can also set the environment variable ``AIRFLOW_CLI_TOKEN`` to the token
to use for authentication.
@@ -76,9 +76,9 @@ For more information use
.. image:: ../images/output_auth_login.svg
:target:
https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_auth_login.svg
:width: 60%
- :alt: Airflow CTL Auth Login Help
+ :alt: airflowctl Auth Login Help
-You are ready to use Airflow CTL now.
+You are ready to use airflowctl now.
Please, also see :doc:`/cli-and-env-variables-ref` for the list of available
commands and options.
You can use the command ``airflowctl --help`` to see the list of available
commands.
@@ -86,13 +86,13 @@ You can use the command ``airflowctl --help`` to see the
list of available comma
.. image:: ../images/output_main.svg
:target:
https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_main.svg
:width: 60%
- :alt: Airflow CTL Help
+ :alt: airflowctl Help
All Available Group Command References
--------------------------------------
-Below are the command reference diagrams for all available commands in Airflow
CTL.
+Below are the command reference diagrams for all available commands in
airflowctl.
These visual references show the full command syntax, options, and parameters
for each command.
**Assets**
@@ -100,81 +100,81 @@ These visual references show the full command syntax,
options, and parameters fo
.. image:: ../images/output_assets.svg
:target:
https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_assets.svg
:width: 60%
- :alt: Airflow CTL Assets Command
+ :alt: airflowctl Assets Command
**Auth**
''''''''
.. image:: ../images/output_auth.svg
:target:
https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_auth.svg
:width: 60%
- :alt: Airflow CTL Auth Command
+ :alt: airflowctl Auth Command
**Backfills**
'''''''''''''
.. image:: ../images/output_backfills.svg
:target:
https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_backfills.svg
:width: 60%
- :alt: Airflow CTL Backfills Command
+ :alt: airflowctl Backfills Command
**Config**
''''''''''
.. image:: ../images/output_config.svg
:target:
https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_config.svg
:width: 60%
- :alt: Airflow CTL Config Command
+ :alt: airflowctl Config Command
**Connections**
'''''''''''''''
.. image:: ../images/output_connections.svg
:target:
https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_connections.svg
:width: 60%
- :alt: Airflow CTL Connections Command
+ :alt: airflowctl Connections Command
**DAGs**
''''''''
.. image:: ../images/output_dag.svg
:target:
https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_dag.svg
:width: 60%
- :alt: Airflow CTL DAG Command
+ :alt: airflowctl DAG Command
**DAG Runs**
''''''''''''
.. image:: ../images/output_dagrun.svg
:target:
https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_dagrun.svg
:width: 60%
- :alt: Airflow CTL DAG Run Command
+ :alt: airflowctl DAG Run Command
**Jobs**
''''''''
.. image:: ../images/output_jobs.svg
:target:
https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_jobs.svg
:width: 60%
- :alt: Airflow CTL Jobs Command
+ :alt: airflowctl Jobs Command
**Pools**
'''''''''
.. image:: ../images/output_pools.svg
:target:
https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_pools.svg
:width: 60%
- :alt: Airflow CTL Pools Command
+ :alt: airflowctl Pools Command
**Providers**
'''''''''''''
.. image:: ../images/output_providers.svg
:target:
https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_providers.svg
:width: 60%
- :alt: Airflow CTL Providers Command
+ :alt: airflowctl Providers Command
**Variables**
'''''''''''''
.. image:: ../images/output_variables.svg
:target:
https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_variables.svg
:width: 60%
- :alt: Airflow CTL Variables Command
+ :alt: airflowctl Variables Command
**Version**
'''''''''''
.. image:: ../images/output_version.svg
:target:
https://raw.githubusercontent.com/apache/airflow/main/airflow-ctl/docs/images/output_version.svg
:width: 60%
- :alt: Airflow CTL Version Command
+ :alt: airflowctl Version Command
diff --git a/airflow-ctl/docs/index.rst b/airflow-ctl/docs/index.rst
index 203cfc8845a..5e7cea898f5 100644
--- a/airflow-ctl/docs/index.rst
+++ b/airflow-ctl/docs/index.rst
@@ -15,9 +15,9 @@
specific language governing permissions and limitations
under the License.
-What is Airflow CTL®?
+What is airflowctl®?
=====================
-Airflow CTL is a command line tool that helps you manage and deploy Apache
Airflow environments.
+airflowctl is a command line tool that helps you manage and deploy Apache
Airflow environments.
.. toctree::
:hidden:
diff --git a/airflow-ctl/docs/installation/dependencies.rst
b/airflow-ctl/docs/installation/dependencies.rst
index 77d20b60907..29c04f63f59 100644
--- a/airflow-ctl/docs/installation/dependencies.rst
+++ b/airflow-ctl/docs/installation/dependencies.rst
@@ -18,7 +18,7 @@
Dependencies
------------
-Airflow CTL dependencies
+airflowctl dependencies
''''''''''''''''''''''''''
The ``apache-airflow-ctl`` PyPI basic package only installs what's needed to
get started.
diff --git a/airflow-ctl/docs/installation/index.rst
b/airflow-ctl/docs/installation/index.rst
index da6c78a905a..bdb0ce96bf5 100644
--- a/airflow-ctl/docs/installation/index.rst
+++ b/airflow-ctl/docs/installation/index.rst
@@ -16,7 +16,7 @@
under the License.
-Installation of Airflow CTL®
+Installation of airflowctl®
----------------------------
.. contents:: :local:
@@ -108,8 +108,8 @@ More details: :doc:`/installation/installing-from-pypi`
**What are you expected to handle**
-* You are expected to install Airflow CTL.
-* You should running Airflow API server.
+* You are expected to install airflowctl.
+* You should run the Airflow API server.
* You need to setup monitoring of your system allowing you to observe
resources and react to problems.
**What Apache Airflow Community provides for that method**
diff --git a/airflow-ctl/docs/installation/installing-from-pypi.rst
b/airflow-ctl/docs/installation/installing-from-pypi.rst
index a02a6a89917..cecd66c354e 100644
--- a/airflow-ctl/docs/installation/installing-from-pypi.rst
+++ b/airflow-ctl/docs/installation/installing-from-pypi.rst
@@ -61,103 +61,3 @@ Those are just examples, see further for more explanation
why those are the best
image.
.. _installation:constraints:
-
-Constraints files
-'''''''''''''''''
-
-Why we need constraints
-=======================
-
-Airflow CTL installation can be tricky because Airflow CTL is both a library
and an application.
-
-Libraries usually keep their dependencies open and applications usually pin
them, but we should do neither
-and both at the same time. We decided to keep our dependencies as open as
possible
-(in ``pyproject.toml``) so users can install different version of libraries if
needed. This means that
-from time to time plain ``pip install apache-airflow-ctl`` will not work or
will produce an unusable
-Airflow CTL installation.
-
-Reproducible Airflow CTL installation
-=====================================
-
-In order to have a reproducible installation, we also keep a set of constraint
files in the
-``constraints-main``, ``constraints-2-0``, ``constraints-2-1`` etc. orphan
branches and then we create a tag
-for each released version e.g. :subst-code:`constraints-|version|`.
-
-This way, we keep a tested set of dependencies at the moment of release. This
provides you with the ability
-of having the exact same installation of airflowctl + dependencies as was
known to be working
-at the moment of release - frozen set of dependencies for that version of
Airflow CTL. There is a separate
-constraints file for each version of Python that Airflow CTL supports.
-
-You can create the URL to the file substituting the variables in the template
below.
-
-.. code-block::
-
-
https://raw.githubusercontent.com/apache/airflow/airflow-ctl/constraints-${AIRFLOWCTL_VERSION}/constraints-${PYTHON_VERSION}.txt
-
-where:
-
-- ``AIRFLOW_CTL_VERSION`` - Airflow CTL version (e.g. :subst-code:`|version|`)
or ``main``, ``2-0``, for latest development version
-- ``PYTHON_VERSION`` Python version e.g. ``3.10``, ``3.11``
-
-
-Verifying installed dependencies
-================================
-
-You can also always run the ``pip check`` command to test if the set of your
Python packages is
-consistent and not conflicting.
-
-
-.. code-block:: bash
-
- > pip check
- No broken requirements found.
-
-
-When you see such message and the exit code from ``pip check`` is 0, you can
be sure, that there are no
-conflicting dependencies in your environment.
-
-
-Using your own constraints
-==========================
-
-When you decide to install your own dependencies, or want to upgrade or
downgrade providers, you might want
-to continue being able to keep reproducible installation of Airflow CTL and
those dependencies via a single command.
-In order to do that, you can produce your own constraints file and use it to
install Airflow CTL instead of the
-one provided by the community.
-
-.. code-block:: bash
-
- pip install "apache-airflow-ctl==|version|"
- pip freeze > my-constraints.txt
-
-
-Then you can use it to create reproducible installations of your environment
in a single operation via
-a local constraints file:
-
-.. code-block:: bash
-
- pip install "apache-airflow-ctl==|version|" --constraint
"my-constraints.txt"
-
-
-Similarly as in case of Airflow CTL original constraints, you can also host
your constraints at your own
-repository or server and use it remotely from there.
-
-Fixing Constraints at release time
-''''''''''''''''''''''''''''''''''
-
-The released "versioned" constraints are mostly ``fixed`` when we release
Airflow CTL version and we only
-update them in exceptional circumstances. For example when we find out that
the released constraints might prevent
-Airflow CTL from being installed consistently from the scratch.
-
-In normal circumstances, the constraint files are not going to change if new
version of Airflow CTL
-dependencies are released - not even when those versions contain critical
security fixes.
-The process of Airflow CTL releases is designed around upgrading dependencies
automatically where
-applicable but only when we release a new version of Airflow CTL, not for
already released versions.
-
-Between the releases you can upgrade dependencies on your own and you can keep
your own constraints
-updated as described in the previous section.
-
-The easiest way to keep-up with the latest released dependencies is to upgrade
to the latest released
-Airflow CTL version. Whenever we release a new version of Airflow CTL, we
upgrade all dependencies to the latest
-applicable versions and test them together, so if you want to keep up with
those tests - staying up-to-date
-with latest version of Airflow CTL is the easiest way to update those
dependencies.
diff --git a/airflow-ctl/docs/installation/installing-from-sources.rst
b/airflow-ctl/docs/installation/installing-from-sources.rst
index 41b52763d55..ad1e616873d 100644
--- a/airflow-ctl/docs/installation/installing-from-sources.rst
+++ b/airflow-ctl/docs/installation/installing-from-sources.rst
@@ -25,7 +25,7 @@ Released packages
This page describes downloading and verifying Airflow® version
``{{ airflow_version }}`` using officially released packages.
- You can also install ``Apache Airflow CTL`` - as most Python packages -
via :doc:`PyPI <installing-from-pypi>`.
+ You can also install ``Apache airflowctl`` - as most Python packages - via
:doc:`PyPI <installing-from-pypi>`.
You can choose different version of Airflow by selecting a different
version from the drop-down at
the top-left of the page.
@@ -41,7 +41,7 @@ dependencies. In case of ``pip`` it means that at least
version 22.1.0 is needed
2022) to build or install Airflow from sources. This does not affect the
ability of installing Airflow from
released wheel packages.
-The |version| downloads of Airflow CTL are available at:
+The |version| downloads of airflowctl are available at:
.. jinja:: official_download_page
@@ -52,7 +52,7 @@ The |version| downloads of Airflow CTL are available at:
* `Whl package for airflow core package <{{ closer_lua_url
}}/apache_airflow_ctl-{{ airflowctl_version }}-py3-none-any.whl>`__ (`asc <{{
base_url }}/apache_airflow_ctl-{{ airflowctl_version
}}-py3-none-any.whl.asc>`__, `sha512 <{{ base_url }}/apache_airflow_ctl-{{
airflowctl_version }}-py3-none-any.whl.sha512>`__)
If you want to install from the source code, you can download from the sources
link above, it will contain
-a ``INSTALL`` file containing details on how you can build and install Airflow
CTL.
+a ``INSTALL`` file containing details on how you can build and install
airflowctl.
Release integrity
'''''''''''''''''
@@ -138,7 +138,7 @@ Example:
Verifying PyPI releases
'''''''''''''''''''''''
-You can verify the Airflow CTL ``.whl`` packages from PyPI by locally
downloading the package and signature
+You can verify the airflowctl ``.whl`` packages from PyPI by locally
downloading the package and signature
and SHA sum files with the script below:
diff --git a/airflow-ctl/docs/installation/prerequisites.rst
b/airflow-ctl/docs/installation/prerequisites.rst
index 615558e450c..9ca449639a7 100644
--- a/airflow-ctl/docs/installation/prerequisites.rst
+++ b/airflow-ctl/docs/installation/prerequisites.rst
@@ -18,16 +18,16 @@
Prerequisites
-------------
-Airflow CTL is tested with:
+airflowctl is tested with:
-The minimum memory required we recommend Airflow CTL to run with is 4GB, but
the actual requirements depend
+The minimum memory required we recommend airflowctl to run with is 200MB, but
the actual requirements depend
wildly on the deployment options you have.
The Keyring backend needs to be installed separately into your operating
system. This will enhance security. See :doc:`/security` for more information.
Keyring Backend
'''''''''''''''
-Airflow CTL uses keyring to store the API token securely. This ensures that
the token is not stored in plain text and is only accessible to authorized
users.
+airflowctl uses keyring to store the API token securely. This ensures that the
token is not stored in plain text and is only accessible to authorized users.
Recommended keyring backends are:
* `macOS Keychain <https://en.wikipedia.org/wiki/Keychain_%28software%29>`_
diff --git a/airflow-ctl/docs/installation/supported-versions.rst
b/airflow-ctl/docs/installation/supported-versions.rst
index 755426c7b6b..18a46b0d36c 100644
--- a/airflow-ctl/docs/installation/supported-versions.rst
+++ b/airflow-ctl/docs/installation/supported-versions.rst
@@ -21,9 +21,9 @@ Supported versions
Version Life Cycle
``````````````````
-Apache Airflow CTL is compatible with Apache Airflow® versions 3.0.0 and later.
+Apache airflowctl is compatible with Apache Airflow® versions 3.0.0 and later.
-Apache Airflow CTL version life cycle:
+Apache airflowctl version life cycle:
.. This table is automatically updated by prek hook
scripts/ci/prek/supported_versions.py
.. Beginning of auto-generated table
@@ -39,4 +39,4 @@ Version Current Patch/Minor State First Release
Limited Support
Limited support versions will be supported with security and critical bug fix
only.
EOL versions will not get any fixes nor support.
-We **highly** recommend installing the latest Airflow CTL release which has
richer features.
+We **highly** recommend installing the latest airflowctl release which has
richer features.
diff --git a/airflow-ctl/docs/security.rst b/airflow-ctl/docs/security.rst
index 1e83537a7a5..8ec5ea6d6f4 100644
--- a/airflow-ctl/docs/security.rst
+++ b/airflow-ctl/docs/security.rst
@@ -17,11 +17,14 @@
Security
========
-Airflow CTL is leveraging Apache Airflow Public API security features and
additional layers of security to ensure that your data is safe and secure.
-Airflow CTL facilitates the seamless deployment of CLI and API features
together, reducing redundancy and simplifying maintenance. Transitioning from
direct database access to an API-driven model will enhance the CLI's
capabilities and improve security.
+airflowctl is leveraging Apache Airflow Public API security features and
additional layers of security to ensure that your data is safe and secure.
+airflowctl facilitates the seamless deployment of CLI and API features
together, reducing redundancy and simplifying maintenance. Transitioning from
direct database access to an API-driven model will enhance the CLI's
capabilities and improve security.
-- **Authentication**: Airflow CTL uses authentication to ensure that only
authorized users can access the system. This is done using an API token. See
more on https://airflow.apache.org/docs/apache-airflow/stable/security/api.html
+- **Authentication**: airflowctl uses authentication to ensure that only
authorized users can access the system. This is done using an API Token. See
more on https://airflow.apache.org/docs/apache-airflow/stable/security/api.html
-- **Keyring**: Airflow CTL uses keyring to store the API token securely. This
ensures that the token is not stored in plain text and is only accessible to
authorized users.
+- **Keyring**: airflowctl uses keyring to store the API Token securely. This
ensures that the Token is not stored in plain text and is only accessible to
authorized users.
-Airflow CTL API Token has its own expiration time. The default is 1 hour. You
can change it in the Airflow configuration file (airflow.cfg) by setting the
``jwt_cli_expiration_time`` parameter under the ``[api_auth]`` section. The
value is in seconds. This will impact all users using ``airflowctl``.
+airflowctl API Token has its own expiration time. The default is 1 hour. You
can change it in the Airflow configuration file (airflow.cfg) by setting the
``jwt_cli_expiration_time`` parameter under the ``[api_auth]`` section. The
value is in seconds. This will impact all users using ``airflowctl``.
+
+For more information see `Setting Configuration
+Options
<https://airflow.apache.org/docs/apache-airflow/stable/howto/set-config.html>`__.
diff --git a/airflow-ctl/docs/start.rst b/airflow-ctl/docs/start.rst
index a57c342ed59..3e1f13dea16 100644
--- a/airflow-ctl/docs/start.rst
+++ b/airflow-ctl/docs/start.rst
@@ -18,10 +18,10 @@
Quick Start
-----------
-Airflow CTL is a command line tool that helps you manage your Airflow
deployments.
+airflowctl is a command line tool that helps you manage your Airflow
deployments.
It is designed to be easy to use and provides a simple interface for managing
your Airflow environment.
-To get started, you can use the following command to create a new Airflow CTL
environment:
+To get started, you can use the following command to create a new airflowctl
environment:
.. code-block:: bash
@@ -38,8 +38,8 @@ OR
export AIRFLOW_CLI_TOKEN=<token>
airflowctl auth login --api-url <api_url> --env <env_name>
-This command will create a new Airflow CTL environment with the specified
username and password.
-You can then use the following command to start the Airflow CTL environment:
+This command will create a new airflowctl environment with the specified
username and password.
+You can then use the following command to start the airflowctl environment:
.. code-block:: bash
diff --git a/airflow-ctl/newsfragments/config.toml
b/airflow-ctl/newsfragments/config.toml
new file mode 100644
index 00000000000..c1f16b10572
--- /dev/null
+++ b/airflow-ctl/newsfragments/config.toml
@@ -0,0 +1,50 @@
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+[tool.towncrier]
+name = "Airflow CTL"
+filename = "RELEASE_NOTES.rst"
+underlines = ["-", '^']
+
+[[tool.towncrier.type]]
+directory = "significant"
+name = "Significant Changes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "feature"
+name = "Features"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "improvement"
+name = "Improvements"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "bugfix"
+name = "Bug Fixes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "doc"
+name = "Doc only Changes"
+showcontent = true
+
+[[tool.towncrier.type]]
+directory = "misc"
+name = "Misc"
+showcontent = true
diff --git a/docs/spelling_wordlist.txt b/docs/spelling_wordlist.txt
index 3084e1ffa52..bfefa5d42f1 100644
--- a/docs/spelling_wordlist.txt
+++ b/docs/spelling_wordlist.txt
@@ -34,6 +34,7 @@ airbnb
Airbyte
airbyte
AirflowConfigParser
+airflowctl
AirflowException
airflowignore
ajax
