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

Jump to bottom

feat: changelog-header configuration #15

Closed
bcoe opened this issue May 5, 2019 · 2 comments
Closed

feat: changelog-header configuration #15

bcoe opened this issue May 5, 2019 · 2 comments
Labels
enhancement New feature or request

Comments

@bcoe
Copy link
Member

bcoe commented May 5, 2019

For standard-version, I would like to provide users with a changelog-header configuration option, which lets them customize the header in the CHANGELOG they're generating.
@bcoe bcoe added the enhancement New feature or request label May 5, 2019
@jbottigliero jbottigliero mentioned this issue May 7, 2019
Merged
@jbottigliero
Copy link
Member

Proposed as:

        "header": {
            "type": "string",
            "description": "A string to be used as the main header section of the CHANGELOG.",
            "default": "# Changelog\n\n"
        },

I didn't go 1:1 with the fallback in standard-version for the default here... I would be open to switching it, I think it just comes down to whether or not the defaults found in the spec are expected to be the defaults for the conventionalcommits preset.

jbottigliero added a commit that referenced this issue May 10, 2019
@jbottigliero
spec: v2.0.0 (#17)
86e063d 
* draft(v2.0.0): Proposal for v2.0.0

- addition: adds `header` property to schema
- change: hides less useful/common `types` mentioned in `conventionalcommits@1.0.0-beta.4`

- restructures tests to be better suited for multiple versions

* docs: adds link to 2.0.0 draft
* chore: bumps version in package.json and README to reflect 2.0.0

closes #16, #15
@jbottigliero
Copy link
Member

I've gone ahead and added header in version 2.0.0 of the spec.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement New feature or request
Milestone
No milestone
Development

No branches or pull requests
2 participants
@bcoe @jbottigliero