Skip to content

Update release-drafter config to support v7 #117

@gaeljw

Description

@gaeljw

The v7 of release-drafter introduces some breaking changes requiring changes in the config files stored here.

See docs: https://github.com/release-drafter/release-drafter/blob/master/docs/configuration-loading.md, mentionned in the changelog:

following the removal of probot, we replaced the Probot Config plugin with custom-made syntax and capabilities. Key takeaways are :

  • fallback to your org/user .github repo does not work anymore. You will need to be explicit about it. (ex: config-name: .github:/configs/release-drafter/main.yaml)
  • the _extends config-keyword now uses the same syntax as the config-name: input. Read more in the Configuration Loading article

See also failed/failing attempts at upgrading release-drafter:

In my understanding, at least 1 thing to fix in this repo is the reference in https://github.com/playframework/.github/blob/main/.github/release-drafts/increasing-minor-version.yml to _extends: .github:.github/release-drafts/base.yml which should be made absolute or relative to the increasing-minor-version.yml?

- _extends: .github:.github/release-drafts/base.yml
+ _extends: .github:/.github/release-drafts/base.yml 
or
+ _extends: .github:base.yml 

Then, some changes may also be required in downstream projects like:

  • explicitly use this .github repo:
- config-name: release-drafts/increasing-minor-version.yml
+ config-name: .github:release-drafts/increasing-minor-version.yml
  • do not specify the .github folder or use absolute path
- _extends: .github:.github/release-drafts/increasing-minor-version.yml
+ _extends: .github:release-drafts/increasing-minor-version.yml 
or 
+ _extends: .github:/.github/release-drafts/increasing-minor-version.yml

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions