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.

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

Custom change-logger #89

Open
wants to merge 30 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 27 commits
Commits
Show all changes
30 commits
Select commit Hold shift + click to select a range
d528d91
feat(news): Add basic module setup
Shivansh-007 Oct 13, 2021
1933610
feat(news): Add command to generate news fragments
Shivansh-007 Oct 14, 2021
a58baee
feat: Add validation for github PR number
Shivansh-007 Oct 15, 2021
7288e07
deps: Add jinja2 for changelog templates
Shivansh-007 Oct 15, 2021
70e0b70
WIP build news support - form metadata from news/ directory
Shivansh-007 Oct 16, 2021
7a1b75b
feat(news): Add TOML configuration support
Shivansh-007 Oct 17, 2021
5440573
Add support for compiling news into version changelog
Shivansh-007 Oct 17, 2021
9dd44ff
Clear scripts/news/next after generating version changelog
Shivansh-007 Oct 17, 2021
aa8bc6f
Add our project specific changelog config
Shivansh-007 Oct 18, 2021
b6c19d4
WIP: Add module for checking news file in a specific pull request
Shivansh-007 Oct 18, 2021
87ffb04
Relock deps; remove redundant ones
Shivansh-007 Oct 19, 2021
6b2d5ef
Add support to run check news from workflow
Shivansh-007 Oct 19, 2021
4f45db1
Document and remove redundant code
Shivansh-007 Oct 20, 2021
bee0dab
Remove news type from path as it is already inside folder
Shivansh-007 Oct 20, 2021
6555c4b
Remove binary pycache files
Shivansh-007 Oct 21, 2021
6e21e33
Add reqeusts to custom changelogger dev deps
Shivansh-007 Oct 25, 2021
30a5155
Correct default template file extension
Shivansh-007 Oct 25, 2021
6459a7a
Add documentationfor news management tool
Shivansh-007 Nov 3, 2021
384ea89
Add option to edit/keep fragments while building
Shivansh-007 Nov 3, 2021
b164477
Merge remote-tracking branch 'origin/main' into feat/custom-changelogger
Shivansh-007 Nov 3, 2021
1b2e521
Address reviews
Shivansh-007 Nov 23, 2021
58643f9
Use incrementing rather than nonceify
Shivansh-007 Nov 23, 2021
803d3c0
Merge branch 'main' into feat/custom-changelogger
Shivansh-007 Nov 27, 2021
aa11a32
deps: run poetry lock --no-update
onerandomusername Nov 27, 2021
63da5f2
Add lock no update task (#133)
Shivansh-007 Nov 27, 2021
85d94f4
Remove star imports :D
Shivansh-007 Dec 8, 2021
0631b3e
Use GITHUB_TOKEN while running the check tool as it would be passed m…
Shivansh-007 Dec 8, 2021
b8efd23
Migrate to new changelog format
Shivansh-007 Dec 14, 2021
2c76232
Make changelog append to latest and not separate per version
Shivansh-007 Dec 14, 2021
1d149db
Merge branch 'main' into feat/custom-changelogger
Shivansh-007 Dec 14, 2021
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
23 changes: 0 additions & 23 deletions .github/workflows/changelog.yml

This file was deleted.

32 changes: 32 additions & 0 deletions .github/workflows/news.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
name: Check for a news entry

on:
pull_request:
types: [opened, synchronize, labeled, unlabeled, reopened]

jobs:
check-news:
runs-on: ubuntu-latest

steps:
# Checks out the repository in the current folder.
- name: Checkout repository
uses: actions/checkout@v2

# Set up the right version of Python
- uses: actions/checkout@v2
- name: Set up Python
uses: actions/setup-python@v2
with:
python-version: '3.9'

# Install the required dependencies for using the feature, we aren't using cache here
# as the number is relatively small and having cache would be complete redundancy.
- name: Install dependencies using pip
run: |
pip install tomli requests

# Run the script for checking if there is a news entry for the current PR
- name: Check for a news entry in the news/next
run: |
python -m scripts.news.check_news_workflow ${{ github.event.pull_request.number }}
1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,7 @@ logs

# Configuration
*config.toml
!scripts/news/config.toml

# Custom docker compose override
docker-compose.override.yml
2 changes: 1 addition & 1 deletion docs/.requirements.txt
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,5 @@
# we have to declare our dependencies here

mkdocs==1.2.3
mkdocs-material==7.2.6
mkdocs-material==7.3.6
mkdocs-markdownextradata-plugin==0.1.9
Empty file added news/next/.gitkeep
Empty file.
1 change: 1 addition & 0 deletions news/next/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
All your changelogs for upcoming release!
Loading