lunny/gitea
Archived
1
1
Fork 1
Code Issues 1.7k Pull Requests 154 Projects Releases 128 Wiki Activity

WIP: Generate Changelog automagically #1298

Closed
bkcsoft wants to merge 4 commits from bkcsoft/changelog-generator into master
pull from: bkcsoft/changelog-generator
merge into: lunny:master
Conversation 10 Commits 4 Files Changed 4 +172 -6
bkcsoft commented 2017-03-17 05:54:53 +00:00 (Migrated from github.com)
Copy Link

What it does:

Automagically generate changelog on make release ?

TODO:

  • Generate changelog
  • Append historical changelog (kept in changelog/HISTORICAL.md
  • Move unreleased-section in current changelog to yaml-files
  • Updated the Makefile
  • Make it efficient ?
  • Document it :trollface:

Format: (stolen from #505)

kind: enhancement # Mandatory! Possible values: breaking, feature, bugfixes, enhancement, misc
title: A short title that explains the change # Mandatory
pull_request: 256 # Mandatory. Number to indicate which PR this was made in.
issue: 234 # Optional. Issue number that got closed by this.
author: tboerger # Optional. The author/authors of the PR

Current implementation is extremely write-intensive... That should be fixed ?

Please be brutal when reviewing this, since it needs to work 100% flawless

I assigned all Owners to review, since we deal with this pain. Also assigned Team maintainers since I want more eyes on this code ?

Closes #505

## What it does: Automagically generate changelog on `make release` ? ### TODO: - [x] Generate changelog - [x] Append historical changelog (kept in `changelog/HISTORICAL.md` - [x] Move unreleased-section in current changelog to yaml-files - [x] Updated the Makefile - [ ] Make it efficient ? - [ ] Document it :trollface: ### Format: (stolen from #505) ``` kind: enhancement # Mandatory! Possible values: breaking, feature, bugfixes, enhancement, misc title: A short title that explains the change # Mandatory pull_request: 256 # Mandatory. Number to indicate which PR this was made in. issue: 234 # Optional. Issue number that got closed by this. author: tboerger # Optional. The author/authors of the PR ``` Current implementation is _extremely_ write-intensive... That should be fixed ? _Please_ be brutal when reviewing this, since **it needs to work** 100% flawless I assigned all Owners to review, since _we_ deal with this pain. Also assigned Team maintainers since I want more eyes on this code ? Closes #505
bkcsoft commented 2017-03-17 06:05:46 +00:00 (Migrated from github.com)
Copy Link

@strk Since I moved your changelog to a file, do you want your full name in there or nickname? (or both)

@strk Since I moved your changelog to a file, do you want your full name in there or nickname? (or both)
tboerger (Migrated from github.com) requested changes 2017-03-17 06:45:18 +00:00
tboerger (Migrated from github.com) left a comment

Maybe generally use log instead of fmt?

Maybe generally use log instead of fmt?
scripts/generate-changelog.go
tboerger (Migrated from github.com) commented 2017-03-17 06:38:16 +00:00

The definition into main to avoid conflicts?

The definition into main to avoid conflicts?
tboerger (Migrated from github.com) commented 2017-03-17 06:38:45 +00:00

Within the other scripts I have moved that into main as well

Within the other scripts I have moved that into main as well
tboerger (Migrated from github.com) commented 2017-03-17 06:41:24 +00:00

Exit?

Exit?
tboerger (Migrated from github.com) commented 2017-03-17 06:44:38 +00:00

Incomplete or unused?

Incomplete or unused?
tboerger (Migrated from github.com) reviewed 2017-03-17 06:46:44 +00:00
changelog/HISTORICAL.md
tboerger (Migrated from github.com) commented 2017-03-17 06:46:13 +00:00

Shouldn't be part of the historical file

Shouldn't be part of the historical file
bkcsoft (Migrated from github.com) reviewed 2017-03-17 07:02:06 +00:00
scripts/generate-changelog.go
bkcsoft (Migrated from github.com) commented 2017-03-17 07:02:06 +00:00

Unused

Unused
strk (Migrated from github.com) reviewed 2017-03-17 08:51:43 +00:00
Makefile
strk (Migrated from github.com) commented 2017-03-17 08:51:43 +00:00

This sounds brutal. A Makefile target that always unconditionally appends to a file ?
I see that file is created by the unreleased/*.md target, but it isn't at all intutitive.

This sounds brutal. A Makefile target that always unconditionally appends to a file ? I see that file is created by the unreleased/*.md target, but it isn't at all intutitive.
lunny commented 2017-03-17 09:24:44 +00:00
Copy Link

ChangeLog codes maybe should be in modules/changelog so that we can add a feature to gitea as generate a changelog. Then when we eat dogfood, we could use it and no need write twice.

ChangeLog codes maybe should be in `modules/changelog` so that we can add a feature to gitea as `generate a changelog`. Then when we eat dogfood, we could use it and no need write twice.
bkcsoft commented 2017-03-19 17:00:49 +00:00 (Migrated from github.com)
Copy Link

@lunny I thought go run didn't like modules. But now that I think about it, it makes a lot of sense to make it a package ?

@lunny I thought `go run` didn't like modules. But now that I think about it, it makes a lot of sense to make it a package ?
bkcsoft commented 2017-03-19 17:01:04 +00:00 (Migrated from github.com)
Copy Link

@lunny Maybe even it's own repo?

@lunny Maybe even it's own repo?
lunny commented 2017-03-20 01:16:09 +00:00
Copy Link

@bkcsoft I just give an advice to reuse the functions. But I cannot give you some ideas about how to do that.

@bkcsoft I just give an advice to reuse the functions. But I cannot give you some ideas about how to do that.
bkcsoft (Migrated from github.com) reviewed 2017-03-20 01:23:50 +00:00
Makefile
bkcsoft (Migrated from github.com) commented 2017-03-20 01:23:50 +00:00

I've updated it so it hopefully makes more sense :)

I've updated it so it hopefully makes more sense :)
bkcsoft commented 2017-03-20 01:24:16 +00:00 (Migrated from github.com)
Copy Link

@tboerger I've updated according to your request :)

@tboerger I've updated according to your request :)
bkcsoft commented 2017-03-24 14:44:47 +00:00 (Migrated from github.com)
Copy Link

@lunny @tboerger I made it into it's own repo. You can find it here: https://gitlab.com/bkc/changelogger

@lunny @tboerger I made it into it's own repo. You can find it here: https://gitlab.com/bkc/changelogger
lunny commented 2017-03-25 04:59:09 +00:00
Copy Link

@bkcsoft great!

@bkcsoft great!
lunny commented 2017-04-07 13:06:59 +00:00
Copy Link

build failed.

build failed.
bkcsoft commented 2017-06-15 02:42:37 +00:00 (Migrated from github.com)
Copy Link

I'm closing this in favour of the actual package.

I'm closing this in favour of the actual package.
This repo is archived. You cannot comment on pull requests.
Reviewers
No reviewers
tboerger
Labels
Clear labels   
backport/done

   
backport/v1.0

   
backport/v1.1

   
backport/v1.10

   
backport/v1.11

   
backport/v1.12

   
backport/v1.13

   
backport/v1.14

   
backport/v1.15

   
backport/v1.2

   
backport/v1.3

   
backport/v1.4

   
backport/v1.5

   
backport/v1.6

   
backport/v1.7

   
backport/v1.8

   
backport/v1.9

   
bounty

   
changelog

   
dependencies

Pull requests that update a dependency file

  
frontport/done

   
frontport/main

   
good first issue

Likely to be an easy fix

  
Hacktoberfest

   
hacktoberfest-accepted

   
in progress

   
kind/api

   
kind/breaking

   
kind/bug

   
kind/build

   
kind/deployment

   
kind/deprecated

   
kind/docs

   
kind/enhancement

   
kind/feature

   
kind/lint

   
kind/misc

   
kind/moderation

features for moderateing spam, abuse, ...

  
kind/package

   
kind/proposal

   
kind/question

   
kind/refactor

   
kind/regression

   
kind/security

   
kind/summary

   
kind/testing

   
kind/translation

   
kind/ui

   
kind/upstream-related

An issue that is caused by an upstream dependency

  
kind/usability

   
kind/ux

   
lgtm/done

   
lgtm/need 1

   
lgtm/need 2

   
performance/bigrepo

Performance Issues affecting Big Repositories

  
performance/cpu

   
performance/memory

Performance issues affecting memory use

  
performance/speed

performance issues with slow downs

  
priority/critical

   
priority/low

   
priority/maybe

   
priority/medium

   
proposal/rejected

   
reviewed/confirmed

Issue has been reviewed and confirmed to be present or accepted to be implemented

  
reviewed/duplicate

   
reviewed/fixed

A fix for this issue is already in the attached milestone

  
reviewed/invalid

   
reviewed/not-a-bug

The reported issue is the intended behavior

  
reviewed/wontfix

   
skip-changelog

   
stale

   
status/blocked

   
status/needs-feedback

   
status/wip

   
theme/2fa

   
theme/authentication

   
theme/avatar

   
theme/backup-restore

   
theme/docker

Docker themed issued

  
theme/federation

   
theme/issues

   
theme/kanban

   
theme/markdown

   
theme/migration

Migration issues

  
theme/mobile

   
theme/pr

   
theme/signing

   
theme/sqlite

   
theme/timetracker

   
theme/webhook

   
theme/wiki
No Label
backport/done
backport/v1.0
backport/v1.1
backport/v1.10
backport/v1.11
backport/v1.12
backport/v1.13
backport/v1.14
backport/v1.15
backport/v1.2
backport/v1.3
backport/v1.4
backport/v1.5
backport/v1.6
backport/v1.7
backport/v1.8
backport/v1.9
bounty
changelog
dependencies
frontport/done
frontport/main
good first issue
Hacktoberfest
hacktoberfest-accepted
in progress
kind/api
kind/breaking
kind/bug
kind/build
kind/deployment
kind/deprecated
kind/docs
kind/enhancement
kind/feature
kind/lint
kind/misc
kind/moderation
kind/package
kind/proposal
kind/question
kind/refactor
kind/regression
kind/security
kind/summary
kind/testing
kind/translation
kind/ui
kind/upstream-related
kind/usability
kind/ux
lgtm/done
lgtm/need 1
lgtm/need 2
performance/bigrepo
performance/cpu
performance/memory
performance/speed
priority/critical
priority/low
priority/maybe
priority/medium
proposal/rejected
reviewed/confirmed
reviewed/duplicate
reviewed/fixed
reviewed/invalid
reviewed/not-a-bug
reviewed/wontfix
skip-changelog
stale
status/blocked
status/needs-feedback
status/wip
theme/2fa
theme/authentication
theme/avatar
theme/backup-restore
theme/docker
theme/federation
theme/issues
theme/kanban
theme/markdown
theme/migration
theme/mobile
theme/pr
theme/signing
theme/sqlite
theme/timetracker
theme/webhook
theme/wiki
Milestone
Clear milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
No Assignees
1 Participants
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: lunny/gitea#1298
No description provided.
Delete Branch "bkcsoft/changelog-generator"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?