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.

Sign up for GitHub

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

Jump to bottom

Creating draft release with inputFilePath specified does not use content #476

Closed
AdmiringWorm opened this issue Nov 3, 2022 · 2 comments · Fixed by #577
Closed

Creating draft release with inputFilePath specified does not use content #476

AdmiringWorm opened this issue Nov 3, 2022 · 2 comments · Fixed by #577
Assignees
@AdmiringWorm
Labels
Breaking Change
Milestone
0.17.0

Comments

@AdmiringWorm
Copy link
Member

Description

When you create a draft release using git release manager and have specified the file to use in release notes using the --inputFilePath argument, it is not being used when drafting the release notes.
Instead it collects the issues needed in the same way as if you never specified the input file path.

Expected Behavior

I would expect GRM to make use of the file that was specified as an inputFilePath instead of doing its own collection of the issues to add.

Actual Behavior

Already mentioned, but GRM create always collects the issues it want, instead of respecting the input file path argument.

Possible Fix

Unknown

Steps to Reproduce

  1. Create a text file with the release notes to use
  2. Run dotnet gitreleasemanager create --token "<GITHUB_TOKEN>" -o "<REPO_USER>" -r "<REPO_NAME>" -m "0.1.0" -i "<PATH_TO_RELEASE_NOTES>" -c "<BRANCH>"
  3. Look at release notes and notice nothing from the specified file was used.

Context

Unable to create the release notes automatically for repositories not following the same convertion as GRM.

Your Environment

  • Version Used: 13.0, 12.1 and 12.0 (could not test earlier versions)
  • Edition Used (.NET Core, .NET Framework): .NET Core
  • Operating System and version (Windows 10, Ubuntu 18.04): Windows 11
  • Link to your project: https://github.com/AdmiringWorm/VideoConverter
  • Link to your CI build (if appropriate): N/A
@AdmiringWorm AdmiringWorm self-assigned this Feb 8, 2024
@AdmiringWorm
Copy link
Member Author

When looking at this, it looks more like we need some validation.

Using a milestone combined with an input file path is incompatible with each other, so we should probably throw an exception in the beginning with this invalid combination instead.

As such, I'll change this to a breaking change instead.

AdmiringWorm added a commit to AdmiringWorm/GitReleaseManager that referenced this issue Feb 8, 2024
@AdmiringWorm
(GitTools#476) Add validation of input file path handler
3456e6a 
This updates how arguments are parsed when attempting to create a new
release. This disallows explicitly the use of a milestone, and an input
file path in the same call.

This is done as there was confusion on why specifying a input file path
was not using the release notes specified. This should make it clearer
to the caller what the issue is.
@AdmiringWorm AdmiringWorm mentioned this issue Feb 12, 2024
Merged
6 tasks
@gep13 gep13 added this to the 0.17.0 milestone Feb 12, 2024
gep13 pushed a commit to AdmiringWorm/GitReleaseManager that referenced this issue Feb 12, 2024
@AdmiringWorm @gep13
(GitTools#476) Add validation of input file path handler
4df7b48 
This updates how arguments are parsed when attempting to create a new
release. This disallows explicitly the use of a milestone, and an input
file path in the same call.

This is done as there was confusion on why specifying a input file path
was not using the release notes specified. This should make it clearer
to the caller what the issue is.
gep13 pushed a commit to AdmiringWorm/GitReleaseManager that referenced this issue Feb 12, 2024
@AdmiringWorm @gep13
(GitTools#476) Add validation of input file path handler
641cf22 
This updates how arguments are parsed when attempting to create a new
release. This disallows explicitly the use of a milestone, and an input
file path in the same call.

This is done as there was confusion on why specifying a input file path
was not using the release notes specified. This should make it clearer
to the caller what the issue is.
gep13 added a commit that referenced this issue Feb 12, 2024
@gep13
Merge pull request #577 from AdmiringWorm/AdmiringWorm/issue476
3303c4c 
(#476) Add validation of input file path handler
gittools-bot pushed a commit that referenced this issue Feb 12, 2024
@web-flow
Continuous Integration Publish: 3303c4c
ee104d9 
Merge pull request #577 from AdmiringWorm/AdmiringWorm/issue476

(#476) Add validation of input file path handler
gep13 added a commit that referenced this issue Mar 9, 2024
@gep13
Merge branch 'release/0.17.0'
98dca9b 
* release/0.17.0:
  (#578) Make the issue ID a long
  (GH-578) Bump Octokit to 10.0.0 to fix oversized ints
  (#574) Exclude all issues with label
  (#476) Add validation of input file path handler
  (#439) Add option to disable warning to stderr
@gittools-bot
Copy link
Contributor

🎉 This issue has been resolved in version 0.17.0 🎉

The release is available on:

Your GitReleaseManager bot 📦🚀

gittools-bot pushed a commit that referenced this issue Mar 9, 2024
@gep13
Continuous Integration Publish: 98dca9b
c76d0b9 
Merge branch 'release/0.17.0'

* release/0.17.0:
  (#578) Make the issue ID a long
  (GH-578) Bump Octokit to 10.0.0 to fix oversized ints
  (#574) Exclude all issues with label
  (#476) Add validation of input file path handler
  (#439) Add option to disable warning to stderr
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@AdmiringWorm AdmiringWorm

Labels
Breaking Change
Projects
None yet
Milestone
0.17.0
Development

Successfully merging a pull request may close this issue.

(#476) Add validation of input file path handler AdmiringWorm/GitReleaseManager
3 participants
@gep13 @AdmiringWorm @gittools-bot