Merge "Add release notes" into stable/zed

vexxhost · Jan 17, 2025 · 9487094 · 9487094
2 parents f7258f9 + 462fb6e
commit 9487094
Show file tree

Hide file tree

Showing 16 changed files with 46 additions and 759 deletions.
diff --git a/.gitignore b/.gitignore
@@ -24,6 +24,7 @@ output
 doc/build
 collections/
 *.egg-info
+CHANGELOG.rst
 
 ## Editors
 .idea

diff --git a/CHANGELOG.md b/CHANGELOG.md
diff --git a/doc/requirements.txt b/doc/requirements.txt
@@ -1,4 +1,6 @@
 furo
+pbr
+reno
 six
 sphinx
 sphinx-autobuild

diff --git a/doc/source/conf.py b/doc/source/conf.py
@@ -22,6 +22,7 @@
 extensions = [
     "sphinx_copybutton",
     "pbr.sphinxext",
+    "reno.sphinxext",
 ]
 
 templates_path = ["_templates"]

diff --git a/doc/source/index.rst b/doc/source/index.rst
@@ -28,6 +28,7 @@ curated by years of experience from our team alongside other features such as:
    config/index
    deploy/index
    admin/index
+   release-notes
 
 
 

diff --git a/doc/source/release-notes.rst b/doc/source/release-notes.rst
@@ -0,0 +1 @@
+.. release-notes:: Release Notes
diff --git a/galaxy.yml b/galaxy.yml
@@ -50,7 +50,6 @@ build_ignore:
   - .pre-commit-config.yaml
   - .python-version
   - .release-please-manifest.json
-  - CHANGELOG.md
   - go.mod
   - go.sum
   - pyproject.toml

diff --git a/releasenotes/config.yaml b/releasenotes/config.yaml
@@ -0,0 +1 @@
+default_branch: main
diff --git a/releasenotes/notes/enforce-release-notes-31a9388c10d21d53.yaml b/releasenotes/notes/enforce-release-notes-31a9388c10d21d53.yaml
@@ -0,0 +1,4 @@
+---
+other:
+  - The project has adopted the use of ``reno`` for release notes, ensuring that
+    all changes include it from now on to ensure proper release notes.
diff --git a/tox.ini b/tox.ini
@@ -87,6 +87,7 @@ deps =
   -r{toxinidir}/doc/requirements.txt
 allowlist_externals =
   rm
+skip_install = true
 commands =
   rm -rf doc/build/html doc/build/doctrees
   sphinx-build -W --keep-going -b html -j auto doc/source doc/build/html
@@ -95,6 +96,7 @@ commands =
 envdir = {[testenv:docs]envdir}
 deps = {[testenv:docs]deps}
 allowlist_externals = {[testenv:docs]allowlist_externals}
+skip_install = {[testenv:docs]skip_install}
 commands =
   rm -rf doc/build/html doc/build/doctrees
   sphinx-autobuild doc/source doc/build/html
@@ -118,3 +120,10 @@ commands =
 [testenv:helm-unittest]
 commands =
   python3 {toxinidir}/hack/helm-unittest.py
+
+[testenv:generate-releasenotes]
+skip_install = true
+deps =
+  reno
+commands =
+  reno report --output {toxinidir}/CHANGELOG.rst
diff --git a/zuul.d/jobs.yaml b/zuul.d/jobs.yaml
@@ -13,6 +13,13 @@
     vars:
       go_command: test ./... -v
 
+- job:
+    name: atmosphere-check-commit
+    nodeset:
+      nodes: []
+    run:
+      - zuul.d/playbooks/check-commit/run.yml
+
 - job:
     name: atmosphere-chart-vendor
     parent: chart-vendor

diff --git a/zuul.d/playbooks/build-collection/pre.yml b/zuul.d/playbooks/build-collection/pre.yml
@@ -12,6 +12,9 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+- name: Generate release notes
+  ansible.builtin.import_playbook: ../common/generate-changelog.yml
+
 - name: Configure Buildset Registry
   ansible.builtin.import_playbook: ../common/configure-buildset-registry.yml
 

diff --git a/zuul.d/playbooks/check-commit/run.yml b/zuul.d/playbooks/check-commit/run.yml
@@ -0,0 +1,4 @@
+- hosts: localhost
+  roles:
+    # TODO(mnaser): This can probably move to a linter/pre-commit.
+    - assert-releasenotes-exist
diff --git a/zuul.d/playbooks/common/generate-changelog.yml b/zuul.d/playbooks/common/generate-changelog.yml
@@ -0,0 +1,7 @@
+- hosts: all
+  tasks:
+    - name: Generate the release notes
+      ansible.builtin.include_role:
+        name: tox
+      vars:
+        tox_envlist: generate-releasenotes
diff --git a/zuul.d/playbooks/linters/pre.yml b/zuul.d/playbooks/linters/pre.yml
@@ -12,6 +12,9 @@
 # License for the specific language governing permissions and limitations
 # under the License.
 
+- name: Generate release notes
+  ansible.builtin.import_playbook: ../common/generate-changelog.yml
+
 - hosts: all
   roles:
     - role: ensure-helm

diff --git a/zuul.d/project.yaml b/zuul.d/project.yaml
@@ -17,6 +17,7 @@
     check:
       jobs:
         - atmosphere-chart-vendor
+        - atmosphere-check-commit
         - atmosphere-golang-go-test
         - atmosphere-linters
         - atmosphere-tox-promtool-test
@@ -87,6 +88,7 @@
     gate:
       jobs:
         - atmosphere-chart-vendor
+        - atmosphere-check-commit
         - atmosphere-golang-go-test
         - atmosphere-linters
         - atmosphere-tox-py3
-Original file line number
+Diff line change
@@ -1,4 +1,6 @@
     furo
+    pbr
+    reno
     six
     sphinx
     sphinx-autobuild
@@ Expand Down @@