Skip to content

Commit

Permalink
Replace changelog/updating with release notes and towncrier now (apac…
Browse files Browse the repository at this point in the history
  • Loading branch information
jedcunningham authored Apr 20, 2022
1 parent 70eede5 commit 5b9bd99
Show file tree
Hide file tree
Showing 55 changed files with 5,232 additions and 4,365 deletions.
2 changes: 1 addition & 1 deletion .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
!.flake8
!.dockerignore
!pytest.ini
!CHANGELOG.txt
!RELEASE_NOTES.rst
!LICENSE
!MANIFEST.in
!NOTICE
Expand Down
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,4 @@ http://chris.beams.io/posts/git-commit/
Read the **[Pull Request Guidelines](https://github.com/apache/airflow/blob/main/CONTRIBUTING.rst#pull-request-guidelines)** for more information.
In case of fundamental code change, Airflow Improvement Proposal ([AIP](https://cwiki.apache.org/confluence/display/AIRFLOW/Airflow+Improvements+Proposals)) is needed.
In case of a new dependency, check compliance with the [ASF 3rd Party License Policy](https://www.apache.org/legal/resolved.html#category-x).
In case of backwards incompatible changes please leave a note in [UPDATING.md](https://github.com/apache/airflow/blob/main/UPDATING.md).
In case of backwards incompatible changes please leave a note in a newsfragement file, named `{pr_number}.significant.rst`, in [newsfragments](https://github.com/apache/airflow/tree/main/newsfragments).
10 changes: 8 additions & 2 deletions .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ repos:
\.cfg$|\.conf$|\.ini$|\.ldif$|\.properties$|\.readthedocs$|\.service$|\.tf$|Dockerfile.*$
- id: insert-license
name: Add license for all rst files
exclude: ^\.github/.*$|^airflow/_vendor/
exclude: ^\.github/.*$|^airflow/_vendor/|newsfragments/.*\.rst$
args:
- --comment-style
- "||"
Expand Down Expand Up @@ -266,7 +266,7 @@ repos:
The word(s) should be in lowercase." && exec codespell "$@"' --
language: python
types: [text]
exclude: ^airflow/_vendor/|^CHANGELOG\.txt$|^airflow/www/static/css/material-icons\.css$|^images/.*$
exclude: ^airflow/_vendor/|^RELEASE_NOTES\.txt$|^airflow/www/static/css/material-icons\.css$|^images/.*$
args:
- --ignore-words=docs/spelling_wordlist.txt
- --skip=docs/*/commits.rst,airflow/providers/*/*.rst,*.lock,INTHEWILD.md,*.min.js,docs/apache-airflow/pipeline_example.csv
Expand Down Expand Up @@ -741,6 +741,12 @@ repos:
files: CHANGELOG\.txt$|CHANGELOG\.rst$
entry: ./scripts/ci/pre_commit/pre_commit_changelog_duplicates.py
pass_filenames: true
- id: newsfragments
name: Check newsfragments are valid
language: python
files: newsfragments/.*\.rst
entry: ./scripts/ci/pre_commit/pre_commit_newsfragments.py
pass_filenames: true
## ADD MOST PRE-COMMITS ABOVE THAT LINE
# The below pre-commits are those requiring CI image to be built
- id: mypy
Expand Down
1 change: 0 additions & 1 deletion .rat-excludes
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@ metastore_db
.*svg
.*csv
.*md5
CHANGELOG.txt
.*zip
.*lock
unittests.cfg
Expand Down
19 changes: 19 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -329,6 +329,25 @@ Step 4: Prepare PR
this step is automatically run while you are committing your code. If not, you can do it manually
via ``git add`` and then ``pre-commit run``.

* Consider adding a newsfragment to your PR so you can add an entry in the release notes.
The following newsfragment types are supported:

* `significant`
* `feature`
* `improvement`
* `bugfix`
* `doc`
* `misc`

Core newsfragments go in `newsfragments <https://github.com/apache/airflow/blob/main/newsfragments>`__
and helm chart newsfragments go in
`chart/newsfragments <https://github.com/apache/airflow/blob/main/chart/newsfragments>`__.
Simply create an rst file named ``{pr_number}.{type}.rst`` (e.g. ``{1234}.bugfix.rst``).

For significant newsfragments, similar to git commits, the first line is the summary and optionally a
body can be added with an empty line separating it.
For other newsfragment types, only use a single summary line.

2. Rebase your fork, squash commits, and resolve all conflicts. See `How to rebase PR <#how-to-rebase-pr>`_
if you need help with rebasing your change. Remember to rebase often if your PR takes a lot of time to
review/fix. This will make rebase process much easier and less painful and the more often you do it,
Expand Down
2 changes: 1 addition & 1 deletion MANIFEST.in
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@

include NOTICE
include LICENSE
include CHANGELOG.txt
include RELEASE_NOTES.rst
include README.md
graft licenses
graft airflow/www
Expand Down
Loading

0 comments on commit 5b9bd99

Please sign in to comment.