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

(maint) Prep for 3.5.0 release #minor #1061

Merged
merged 1 commit into from
May 6, 2020

Conversation

justinstoller
Copy link
Member

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.

@justinstoller justinstoller requested a review from a team May 6, 2020 20:47
@justinstoller
Copy link
Member Author

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
Copy link
Contributor

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.

Copy link
Member Author

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.

Copy link
Member Author

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?

Copy link
Contributor

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
Copy link
Contributor

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

Copy link
Member Author

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.

Copy link
Member Author

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 ( :

Copy link
Contributor

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
Copy link
Contributor

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..

Copy link
Member Author

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.

Copy link
Member Author

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.

Copy link
Contributor

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.
@justinstoller justinstoller force-pushed the maint/master/release-350 branch from e5671f9 to 08ee53e Compare May 6, 2020 21:06

- 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).
Copy link
Contributor

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

Copy link
Member Author

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.

Copy link
Member Author

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?

Copy link
Contributor

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

Copy link
Collaborator

@Magisus Magisus May 6, 2020

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.

@Magisus Magisus merged commit 6f4abf0 into puppetlabs:master May 6, 2020
@justinstoller justinstoller deleted the maint/master/release-350 branch April 27, 2021 22:05
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 this pull request may close these issues.

3 participants