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

configure_sections needs better examples #923

Closed
bruce-szalwinski opened this issue Dec 16, 2020 · 2 comments
Closed

configure_sections needs better examples #923

bruce-szalwinski opened this issue Dec 16, 2020 · 2 comments

Comments

@bruce-szalwinski
Copy link
Contributor

bruce-szalwinski commented Dec 16, 2020

The documentations is not clear what the value for configure_sections parameter should be. Looking through the code, it appears that it wants a JSON document but the docs don't expose what the keys of this document should be. Thru some poking around, I came up with this format which works.

{
    "enhancements": {
        "prefix": ":sparkles: Enhancements",
        "labels": [
            "enhancement",
            "feat"
        ]
    },
    "bugs": {
        "prefix": ":bug: Bug Fixes",
        "labels": [
            "fix"
        ]
    },
    "refactor": {
        "prefix": ":hammer: Refactor",
        "labels": [
            "refactor"
        ]
    },
    "books": {
        "prefix": ":books: Documentation",
        "labels": [
            "docs"
        ]
    },
    "style": {
        "prefix": ":gem: Style",
        "labels": [
            "style"
        ]
    },
    "performance": {
        "prefix": ":rocket: Performance",
        "labels": [
            "perf",
            "performance"
        ]
    },
    "test": {
        "prefix": ":heart: Test",
        "labels": [
            "test"
        ]
    },
    "build": {
        "prefix": ":package: Build",
        "labels": [
            "build",
            "ci"
        ]
    },
    "chore": {
        "prefix": ":wrench: Chore",
        "labels": [
            "chore"
        ]
    }
}

The config reader doesn't support multi-line config (ala yaml or json), so I ended up having to minify this document into one line which makes it cumbersome to edit.

I guess a second issue would be to convert the config reader to something other than key=value

@bruce-szalwinski
Copy link
Contributor Author

@olleolleolle
Copy link
Collaborator

@bruce-szalwinski Could you make a PR adding a link to that place? I mean, to help Bruce-in-the-past find the content.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants