semantic-release / semantic-release/release-notes-generator

Defining the commitPartial voids other wirter and presetConfig options

Open
#399 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
368
Forks
55
Avg merge
10m
Merged PRs (30d)
1

Description

I have the .releaserc as

- - "@semantic-release/release-notes-generator"
  - presetConfig:
      issuePrefixes: ["xyz-", "abc-"]
      issueUrlFormat: "https://my.atlassian.net/browse/{{id}}"
    preset: conventionalcommits
    writerOpts:
      commitsSort: ["subject", "scope"]   
      commitPartial: |-
        * {{header}}
        {{~!-- commit link --}} {{#if @root.linkReferences~}}
          ([{{hash}}](
          {{~#if @root.repository}}
            {{~#if @root.host}}
              {{~@root.host}}/
            {{~/if}}
            {{~#if @root.owner}}
              {{~@root.owner}}/
            {{~/if}}
            {{~@root.repository}}
          {{~else}}
            {{~@root.repoUrl}}
          {{~/if}}/
          {{~@root.commit}}/{{hash}}))
        {{~else}}
          {{~hash}}
        {{~/if}}
        {{~!-- commit references --}}
        {{~#if references~}}
          , closes
          {{~#each references}} {{#if @root.linkReferences~}}
            [
            {{~#if this.owner}}
              {{~this.owner}}/
            {{~/if}}
            {{~this.repository}}#{{this.issue}}](
            {{~#if @root.repository}}
              {{~#if @root.host}}
                {{~@root.host}}/
              {{~/if}}
              {{~#if this.repository}}
                {{~#if this.owner}}
                  {{~this.owner}}/
                {{~/if}}
                {{~this.repository}}
              {{~else}}
                {{~#if @root.owner}}
                  {{~@root.owner}}/
                {{~/if}}
                  {{~@root.repository}}
                {{~/if}}
            {{~else}}
              {{~@root.repoUrl}}
            {{~/if}}/
            {{~@root.issue}}/{{this.issue}})
          {{~else}}
            {{~#if this.owner}}
              {{~this.owner}}/
            {{~/if}}
            {{~this.repository}}#{{this.issue}}
          {{~/if}}{{/each}}
        {{~/if}} - {{author.name}}

As soon as I define the commitPartial in the config the other default and defined options are not respected; when it is present the issues are not linked, the commit sha is not transformed to 7 chars.
Removing it make the other things work. Am I missing something here?
The template is the default one picked from the repo... we just added the - {{author.name}} at the end

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the .releaserc configuration and the default commitPartial template from the repository, comparing output with and without commitPartial. Verify whether issue links and seven-character commit SHAs remain enabled while the custom author suffix is preserved; done means all configured options work together.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
release
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.