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

assets option is ambiguous with git plugin assets option #808

Open
esatterwhite opened this issue Apr 5, 2024 · 0 comments · May be fixed by #809
Open

assets option is ambiguous with git plugin assets option #808

esatterwhite opened this issue Apr 5, 2024 · 0 comments · May be fixed by #809

Comments

@esatterwhite
Copy link

esatterwhite commented Apr 5, 2024

Both the git plugin and github plugin have a configuration option named assets. When building out a shareable configuration, It is preferable to omit configuration inline with the plugin and define as much as possible in the top level of the release config so they can be overridden when the configuration is extended.

// my-release-config/index.js
module.exports = {
  npmPublish: false,
  releaseRules: [...],
  assets: ['package.json', '*.md', '!**/node_modules/**'],  // <---- assets
  changelogTitle: '## Changelog',
  plugins: [
    ['@semantic-release/commit-analyzer', null],
    ['@semantic-release/release-notes-generator', null],
    ['@semantic-release/changelog', null]
    ['@semantic-release/npm', null],
    ['@semantic-release/git', null],
    ['@semantic-release/exec', null],
    ['@semantic-release/github', null]
  ]
}

This works rather well except when you use the git and github plugins together - the assets configuration is ambiguous meaning. In the above example, All .md files will be included in both the release commit, and the files attached to the github release. if the value needs to be different between the two plugins, you have to define the plugin configuration inline, which makes it difficult to change

// my-release-config/index.js
module.exports = {
  npmPublish: false,
  releaseRules: [...],
  changelogTitle: '## Changelog',
  plugins: [
    ['@semantic-release/commit-analyzer', null],
    ['@semantic-release/release-notes-generator', null],
    ['@semantic-release/changelog', null]
    ['@semantic-release/npm', null],
    ['@semantic-release/git', {
      assets: ['package.json', '*.md', '!**/node_modules/**'] // <---- assets
    }]
    ['@semantic-release/exec', null],
    ['@semantic-release/github', {
       assets: ['dist/*.tgz', 'coverage/*.json']              // <---- assets
    }]
  ]
}

This allows them to be different, But now you cannot really over ride these values individually with out modifying them both, or changing them in the actualy config package being exteded. Which mean people have to re-define the entire plugin change and re-create most of the default configuration shipped with the shared config. Which mostly defeats the purpose.

Ideally, these settings should be named differently to disambiguate them - gitCommitAssets and githubReleaseAssets.
Something to this effect. It could initially be alternate value to allow the existing assets value to work if defined like it currently does.

esatterwhite added a commit to esatterwhite/github that referenced this issue Apr 5, 2024
Includes the addition of a new option githubReleaseAssets to replace the
old assets option. The assets option is identical to the option found in
the git plugin but is ambiguous when used in shared configuration
packages.

Fixes: semantic-release#808
@esatterwhite esatterwhite linked a pull request Apr 5, 2024 that will close this issue
esatterwhite added a commit to esatterwhite/github that referenced this issue Apr 10, 2024
Includes the addition of a new option githubReleaseAssets to replace the
old assets option. The assets option is identical to the option found in
the git plugin but is ambiguous when used in shared configuration
packages.

Fixes: semantic-release#808
esatterwhite added a commit to esatterwhite/github that referenced this issue Apr 17, 2024
Includes the addition of a new option githubReleaseAssets to replace the
old assets option. The assets option is identical to the option found in
the git plugin but is ambiguous when used in shared configuration
packages.

Fixes: semantic-release#808
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

Successfully merging a pull request may close this issue.

1 participant