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

release note generator to clickup tasks

Open
#680 1 comment 1 reaction 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

Hi,

I am trying to add a link to my clickup task from the changed the changelog.md file.
The commit message should look something like this:

test: dummy tests

closes #task_id_clickup

The changelog.md is including the closes part but somehow truncating the id ( only taking the first 7 characters), for instance if my clickup task ID is 123456789 , he will use in the changelog file 1234567 as id ( which is wrong).

Any idea to fix this ?

below is my .releaserc file:

{
  "branches": ["main", "next"],
  "plugins": [
    [
      "@semantic-release/commit-analyzer",
      {
        "preset": "angular",
        "releaseRules": [
          { "type": "build", "release": false },
          { "type": "ci", "release": false },
          { "type": "docs", "release": false },
          { "type": "feat", "release": "minor" },
          { "type": "fix", "release": "patch" },
          { "type": "perf", "release": "patch" },
          { "type": "refactor", "release": "patch" },
          { "type": "test", "release": false },
          { "type": "chore", "release": "patch" }
        ],
        "parserOpts": {
          "noteKeywords": ["BREAKING CHANGE", "BREAKING CHANGES"]
        }
      }
    ],
    [
      "@semantic-release/release-notes-generator",
      {
        "preset": "conventionalcommits",
        "presetConfig": {
          "types": [
            { "type": "feat", "section": "Features" },
            { "type": "fix", "section": "Bug Fixes" },
            { "type": "perf", "section": "Performance Improvements" },
            { "type": "revert", "section": "Reverts" },
            { "type": "docs", "section": "Documentation" },
            { "type": "style", "section": "Styles" },
            { "type": "refactor", "section": "Code Refactoring" },
            { "type": "test", "section": "Tests" },
            { "type": "build", "section": "Build System" },
            { "type": "ci", "section": "Continuous Integration" },
            { "type": "chore", "section": "Chores" }
          ]
        },
        "issueUrlFormat": "https://app.clickup.com/t/{{id}}",
        "issuePrefixes": ["#"]
      }
    ],
    [
      "@semantic-release/changelog",
      {
        "changelogTitle": "# Changelog\n\nAll notable changes to this project will be documented in this file. See\n[Conventional Commits](https://conventionalcommits.org) for commit guidelines."
      }
    ],
    [
      "@semantic-release/git",
      {
        "message": "chore: Release ${nextRelease.version}\n\n${nextRelease.notes}"
      }
    ]
  ]
}

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, especially the release-notes-generator settings for issueUrlFormat and issuePrefixes, and compare them with the generated changelog.md output. Reproduce the reported case using a ClickUp task ID such as 123456789; done means the changelog link retains the complete task ID rather than truncating it.

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
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.