-
Notifications
You must be signed in to change notification settings - Fork 352
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
(maint) Prep for 3.5.0 release #minor #1061
(maint) Prep for 3.5.0 release #minor #1061
Conversation
Does this look correct wrt our new GH Actions release workflow? |
3.5.0 | ||
----- | ||
|
||
- Add exec environment source type. The exec source type allows for the |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
oh, are we wrapping now? personally, I don't love wrapping text/markdown, but maybe that's just me.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I couldn't tell if there was a strong preference in the doc already and it's a pet peeve of mine.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
what do you have against wrapping text?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
personally, I find it harder to read. But I don't care too strongly, since we seem to do both in this file.
- Add exec environment source type. The exec source type allows for the | ||
implementation of external environment sources | ||
[#1042](https://github.com/puppetlabs/r10k/pull/1042). | ||
- Improve atomicity of .r10k-deploy.json writes. Fixes |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If we're linking to PRs, let's be consistent. 😊 #1039
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tbh, I only linked to the one PR because its impossible to tell what's going on from the ticket itself. I don't think linking folks to code is generally a best practice (its got a little bit of a if you want to know go rtfm vibe), but I didn't want to re-write someone JIRA ticket rn.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If your preference is to remove the note about the one that includes a PR in it, then I think that would get us back to consistency ( :
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
tbh I agree with you that linking to code in the changelog feels kinda silly.. Just trying to understand what our standards are. In that case, I don't think we should link to the other ones..
CHANGELOG.mkd
Outdated
[#1042](https://github.com/puppetlabs/r10k/pull/1042). | ||
- Improve atomicity of .r10k-deploy.json writes. Fixes | ||
[#813](https://github.com/puppetlabs/r10k/issues/813) | ||
- Fix option checks from newest CRI bump. See |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I didn't really think this warranted a changelog entry, since it doesn't change functionality..
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
My impression was that it fixed a regression introduced in the last release + latest CRI. Like I mentioned in my other comment, I couldn't really follow the ticket.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I'll just remove this and kill two birds with one stone.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think the latest CRI fixes the regression. We had previously pinned back to avoid it. @pcarlisle Do you know if we're in a broken state right now, with cri 2.15.10 (latest) but with your options fixes not-quite-released?
Updates CHANGELOG with missing entries and for formatting. Updates VERSION constant to 3.5.0.
e5671f9
to
08ee53e
Compare
|
||
- Add exec environment source type. The exec source type allows for the | ||
implementation of external environment sources | ||
[#1042](https://github.com/puppetlabs/r10k/pull/1042). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
this links to a PR too
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Ha, I totally read it as an issue.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Looking into it, I'm not sure what to do with that one since there's no issue or ticket with it but afaict it does implement a new feature. I think I'd leave the link to the PR in, not because I think folks should go see the back and forth about the code review, or go read the code, but because it's the best place to find a high level understanding of the feature... What do you think?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
hmm yeah, I get that.. I don't know, I hate changelogs lol
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah I think it's less important what is linked to, than that the link takes you somewhere to get more detail, with a preference for issues or tickets.
Updates CHANGELOG with missing entries and for formatting. Updates
VERSION constant to 3.5.0.
Please add all notable changes to the "Unreleased" section of the CHANGELOG.