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

Why commits got repeated when I format the CHANGELOG file manually? #133

Open
JonathanLoscalzo opened this issue Mar 30, 2024 · 5 comments
Labels
question Further information is requested

Comments

@JonathanLoscalzo
Copy link

I have wanted to edit the changelog manually, because I have a lot of all commits in the history that I don't want to preserve in the changelog.
During the edition, accidentally I have format the file with vscode and some blank spaces got removed.

When I bump the version again, the selected commits are not from "v0.0.X..v.0.0.Y", it selects it from the first commit again.

So, I assumed that if we modify the format of the changelog for whatever reason, it will fail.
Is there any possibility to pass two properties? like the range of commits to generate instead of read the changelog.

There are situation where we want to switch from a changelog generator to another, and I want to preserve all history. I mean, it could be possible to skip that check and just use last two "v-tags"?

@JonathanLoscalzo JonathanLoscalzo added the question Further information is requested label Mar 30, 2024
@TimothyJones
Copy link
Member

This shouldn’t happen - are you sure the tags are visible when you’re running the tool? It sounds more like missing tags than a problem with editing the changelog

@JonathanLoscalzo
Copy link
Author

Let me create a template example with my project

@JonathanLoscalzo
Copy link
Author

JonathanLoscalzo commented Mar 30, 2024

Check the script... when I have formatted it with prettier, in the following bump it duplicates the entries.

npm init --yes
git init
echo "node_modules" > .gitignore
git add . 
git commit -m "feat: init"

for i in {1..5}; do
  git commit -m "feat($i): important feature $i" --allow-empty
done

for i in {1..5}; do
  git commit -m "fix($i): important feature $i" --allow-empty
done

npx --yes commit-and-tag-version --first-release

# modify the changelog JUST THE FORMAT
echo "{}" > .prettierrc
npx --yes prettier CHANGELOG.md --write
git add CHANGELOG.md 
git commit --amend --no-edit

# Create a commit between v1 and v2
git commit -m "feat(v2): important feature v2" --allow-empty


# If I release it, the unique commit that will be added to the changelog is the last one
npx commit-and-tag-version 

# CHECK CHANGELOG!

@JonathanLoscalzo
Copy link
Author

If you comment the prettier part, it works. So the problem is in the md formatting.
😢

@JonathanLoscalzo
Copy link
Author

Any thoughts @TimothyJones ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants