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.

Sign up for GitHub

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

Migrate changelog snippets and release notes to markdown #63710

Merged
merged 7 commits into from
Feb 17, 2023
Merged

Migrate changelog snippets and release notes to markdown #63710

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ef44c54
Converted the changelog setup to markdown
s0undt3ch Feb 13, 2023
441d006
Move the check-changelog-entries pre-commit local hook to tools.
s0undt3ch Feb 15, 2023
220dc72
Start writing the release notes in markdown.
s0undt3ch Feb 13, 2023
9a8f5f2
Properly handle, and display, errors.
s0undt3ch Feb 13, 2023
0e2ad07
Set the `LATEST_RELEASE` environment variable when building docs
s0undt3ch Feb 14, 2023
d5d0fe5
Update the `changelog` nox session to redirect to `tools` and warn ab…
s0undt3ch Feb 16, 2023
2d8af8f
Update the changelog related documentation
s0undt3ch Feb 16, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions .github/workflows/ci.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,8 @@ jobs:

- name: Build Documentation
shell: bash
env:
LATEST_RELEASE: ${{ needs.prepare-workflow.outputs.salt-version }}
run: |
tools docs html --no-clean --archive salt-${{ needs.prepare-workflow.outputs.salt-version }}-docs.tar.xz

Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/nightly.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,8 @@ jobs:

- name: Build Documentation
shell: bash
env:
LATEST_RELEASE: ${{ needs.prepare-workflow.outputs.salt-version }}
run: |
tools docs html --no-clean --archive salt-${{ needs.prepare-workflow.outputs.salt-version }}-docs.tar.xz

Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/scheduled.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -259,6 +259,8 @@ jobs:

- name: Build Documentation
shell: bash
env:
LATEST_RELEASE: ${{ needs.prepare-workflow.outputs.salt-version }}
run: |
tools docs html --no-clean --archive salt-${{ needs.prepare-workflow.outputs.salt-version }}-docs.tar.xz

Expand Down
2 changes: 2 additions & 0 deletions .github/workflows/templates/ci.yml.jinja
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,6 +104,8 @@ on:

- name: Build Documentation
shell: bash
env:
LATEST_RELEASE: ${{ needs.prepare-workflow.outputs.salt-version }}
run: |
tools docs html --no-clean --archive salt-${{ needs.prepare-workflow.outputs.salt-version }}-docs.tar.xz

Expand Down
22 changes: 12 additions & 10 deletions .pre-commit-config.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,19 @@ repos:
)$

- repo: https://github.com/s0undt3ch/python-tools-scripts
rev: "0.10.2"
rev: "0.10.4"
hooks:
- id: tools
alias: check-changelog-entries
name: Check Changelog Entries
args:
- changelog
- pre-commit-checks
additional_dependencies:
- boto3==1.21.46
- pyyaml==6.0
- jinja2==3.1.2
- packaging==23.0
- id: tools
alias: generate-workflows
name: Generate GitHub Workflow Templates
Expand Down Expand Up @@ -1080,15 +1091,6 @@ repos:
- requirements/static/ci/tools.in
# <---- Tools -----------------------------------------------------------------------------------------------------

# ----- Local Hooks ----------------------------------------------------------------------------------------------->
- repo: local
hooks:
- id: check-changelog-entries
name: Check Changelog Entries
entry: .pre-commit-hooks/check-changelog-entries.py
language: script
# <---- Local Hooks ------------------------------------------------------------------------------------------------

# ----- Code Formatting ------------------------------------------------------------------------------------------->
- repo: https://github.com/asottile/pyupgrade
rev: v2.37.2
Expand Down
104 changes: 0 additions & 104 deletions .pre-commit-hooks/check-changelog-entries.py
View file
Open in desktop

This file was deleted.

Loading