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

Fix Changelog LatestVersion Property #1240

Open
wants to merge 10 commits into
base: develop
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 19 additions & 19 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ As a community, we want to help each other, provide constructive feedback, and m

## Consumer Expectations

NUKE is a personal project that was made open-source to let the whole community benefit from it **free of charge** but also ["as is"](https://github.com/nuke-build/nuke/blob/develop/LICENSE). Like a lot of open-source projects, it is primarily maintained and developed by a [single person](https://github.com/matkoch). Some of the **most time-consuming tasks** around the project are:
NUKE is a personal project that was made open-source to let the whole community benefit from it **free of charge** but also ["as is"](https://github.com/nuke-build/nuke/blob/develop/LICENSE). Like many open-source projects, it is primarily maintained and developed by a [single person](https://github.com/matkoch). Some of the **most time-consuming tasks** around the project are:

- Development of the NuGet package itself (C#, .NET, MSBuild)
- Collecting CLI metadata (.NET ClI, MSBuild, Docker, +30 others)
Expand All @@ -14,32 +14,31 @@ NUKE is a personal project that was made open-source to let the whole community
- Hosting (Azure, Cloudflare, Algolia, Fathom)
- Documentation, presentation slides, and blog posts
- Helping in GitHub issues/discussions, Slack, and Discord
- Talking at conferences and meetups including travel
- Talking at conferences and meetups, including travel
- Promotion on Twitter and Mastodon

This list should give you an impression of what it took to make NUKE what it is today and what it continuously takes to move it forward. Obviously though, there's only a limited amount of time a single person can dedicate besides their personal life and real job [without burning out](https://www.jeffgeerling.com/blog/2022/burden-open-source-maintainer).
This list should give you an impression of what it took to make NUKE what it is today and what it continuously takes to move it forward. Obviously, though, there's only a limited amount of time a single person can dedicate besides their personal life and real job [without burning out](https://www.jeffgeerling.com/blog/2022/burden-open-source-maintainer).

Therefore, **everything that benefits a larger audience is prioritized** over digging into issues that only affect a single or few individuals. Please don't take offense when your issue or pull-request is not getting the attention you were hoping for. It is simply a time management decision.
Therefore, **everything that benefits a larger audience is prioritized** over digging into issues that only affect a single or few individuals. Please don't take offense when your issue or pull request is not getting the attention you were hoping for. It is simply a time management decision.

## Baseline Contributions

There are a number of minimal to zero efforts you can make to show your support for the project:
There are several minimal to zero efforts you can make to show your support for the project:

- Give the [GitHub project](https://github.com/nuke-build/nuke/stargazers) a star (and tell your team)
- Follow [@nukebuildnet](https://twitter.com/nukebuildnet) and [@[email protected]](https://dotnet.social/@nuke)
- Upvote, share, and comment our content (see [#mentions](https://app.slack.com/client/T9QUKHC4A/CDJD8CGQ5) on Slack)
- Upvote, share and comment on our content (see [#mentions](https://app.slack.com/client/T9QUKHC4A/CDJD8CGQ5) on Slack)
- Talk about NUKE on social media and let others know where it can help (tag us!)

The above points are considered somewhat of the norm in exchange for using the project free of charge.

## Sustainability Contributions

There are plenty of ways to show your commitment to the project and strengthen its longevity. These are typically tied to contributing time or money, but also allow for prioritizing your individual issues in return:
There are plenty of ways to show your commitment to the project and strengthen its longevity. These are typically tied to contributing time or money but also allow for prioritizing your own issues in return:

- [Convince your company to sponsor](https://humanwhocodes.com/blog/2021/05/talk-to-your-company-sponsoring-open-source/)
- Sponsor personally (e.g., when the project improves your work performance reviews)
- Fix or investigate issues that are marked as [`good first issue`](https://github.com/nuke-build/nuke/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22)
- Take ownership for a tool wrapper or CI/CD service (.NET CLI, GitHub Actions, ...)
- Take ownership of a tool wrapper or CI/CD service (.NET CLI, GitHub Actions, etc.)
- Write a blog post or give a meetup talk (let us know!)
- Help others in GitHub issues/discussions or on Slack and Discord

Expand All @@ -54,14 +53,14 @@ Evaluate whether your topic is going to be a valid issue:
- Have you read and searched the [documentation](https://nuke.build/docs/introduction/)?
- Have you checked the [FAQ](https://nuke.build/faq/)?
- Is your issue more of a question? Ask on [GitHub discussions](https://github.com/nuke-build/nuke/discussions), [Slack](https://nuke.build/slack), or [Discord](https://nuke.build/discord)!
- Have you checked existing/closed issues? Maybe your version is behind?
- Did you verify it's not an external tool issue? Invoke the command manually!
- Don't file issues for tool wrappers. Send a pull-request instead!
- Have you checked existing/closed issues? Is your version behind?
- Have you verified it's not an external tool issue? Invoke the command manually!
- Don't file issues for tool wrappers. Send a pull request instead!
- Refrain from debating the governance or state of the project out of your own interests (see [consumer expectations](#consumer-expectations) & [sustainability contributions](#sustainability-contributions))

### When creating an issue

Choose one of the [issue templates](https://github.com/nuke-build/nuke/issues/new/choose) and fill it out as good as possible. This includes, but is not limited to:
Choose one of the [issue templates](https://github.com/nuke-build/nuke/issues/new/choose) and fill it out as well as possible. This includes, but is not limited to:

- State the issue as short as possible (more likely there's time to comprehend it)
- Use [markdown](https://docs.github.com/en/get-started/writing-on-github) for code, logs, and other special text fragments
Expand All @@ -74,12 +73,12 @@ Choose one of the [issue templates](https://github.com/nuke-build/nuke/issues/ne

Once the `triage` label is removed from your issue, you will know how it is seen from the project's perspective:

- Issues labelled as `area:cicd` or `area:tools` usually can be fixed in user code
- Issues labeled as `area:cicd` or `area:tools` usually can be fixed in user code
- [Custom arguments](https://nuke.build/docs/common/cli-tools/#custom-arguments) can be wrapped in local extension methods
- Additional steps in CI/CD configuration generation can be added through inheritance
- If your issue is labelled as `good first issue`, consider sending a pull-request
- If your issue is labeled as `good first issue`, consider sending a pull-request

Depending on the priority, available time, and your personal commitment to the project, the issue will be addressed sooner or later. In (hopefully) rare cases, it might also be closed due to missing resources.
The issue will be addressed sooner or later depending on the priority, available time, and your commitment to the project. In rare cases, it might also be closed due to missing resources.

## Pull-Requests

Expand All @@ -96,9 +95,9 @@ In your own interest of getting a pull-request merged (timely):

- Aim for qualitative and readable code
- Follow the coding style of the existing codebase
- Make sure the project builds and all tests pass
- Make sure the project builds, and all tests pass
- Don't copy/paste chunks of code, even when it's meant as a draft
- Drafting APIs is okay, as long as you're ready to finish it later
- Drafting APIs is okay as long as you're ready to finish it later
- Add tests when meaningful, particularly when there is a related test class already

### When creating a pull-request
Expand All @@ -118,7 +117,8 @@ For tool wrappers (e.g. [.NET CLI](https://github.com/nuke-build/nuke/blob/devel
- `<para/>` in between paragraphs (as opposed to `<p>...</p>`)
- Don't explicitly define `secret: false` (it's the default)
- Don't provide `default: xxx` (it's obsolete)
- Don't generate the code; it will be done manually once per release
- Test your changes by calling the `GenerateTools` target
- Don't commit generated code; it will be done manually once per release

### After creating a pull-request

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]
- Added something

## [6.2.1] / 2022-08-19
- Fixed something

## [6.2.0] / 2022-08-19
- Added something

## [0.4.0] / 2018-05-02
- Deprecated something

## [0.3.1] / 2018-03-26
- Deprecated something

## [0.2.10] / 2018-03-05
- Fixed something

## [0.2.0] / 2018-02-26
- Deprecated something

[Unreleased]: https://github.com/nuke-build/nuke/compare/6.2.1...HEAD
[6.2.1]: https://github.com/nuke-build/nuke/compare/6.2.0...6.2.1
[6.2.0]: https://github.com/nuke-build/nuke/compare/0.4.0...6.2.0
[0.4.0]: https://github.com/nuke-build/nuke/compare/0.3.1...0.4.0
[0.3.1]: https://github.com/nuke-build/nuke/compare/0.2.10...0.3.1
[0.2.10]: https://github.com/nuke-build/nuke/compare/0.2.0...0.2.10
[0.2.0]: https://github.com/nuke-build/nuke/tree/0.2.0
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [Unreleased]

## [6.3.0] / 2022-12-12
- Added something

## [6.2.1] / 2022-08-19
- Fixed something

## [6.2.0] / 2022-08-19
- Added something

## [0.4.0] / 2018-05-02
- Deprecated something

## [0.3.1] / 2018-03-26
- Deprecated something

## [0.2.10] / 2018-03-05
- Fixed something

## [0.2.0] / 2018-02-26
- Deprecated something

[Unreleased]: https://github.com/nuke-build/nuke/compare/6.3.0...HEAD
[6.3.0]: https://github.com/nuke-build/nuke/compare/6.2.1...6.3.0
[6.2.1]: https://github.com/nuke-build/nuke/compare/6.2.0...6.2.1
[6.2.0]: https://github.com/nuke-build/nuke/compare/0.4.0...6.2.0
[0.4.0]: https://github.com/nuke-build/nuke/compare/0.3.1...0.4.0
[0.3.1]: https://github.com/nuke-build/nuke/compare/0.2.10...0.3.1
[0.2.10]: https://github.com/nuke-build/nuke/compare/0.2.0...0.2.10
[0.2.0]: https://github.com/nuke-build/nuke/tree/0.2.0
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [vNext]
- Added something

## [6.2.1] / 2022-08-19
- Fixed something

## [6.2.0] / 2022-08-19
- Added something

## [0.4.0] / 2018-05-02
- Deprecated something

## [0.3.1] / 2018-03-26
- Deprecated something

## [0.2.10] / 2018-03-05
- Fixed something

## [0.2.0] / 2018-02-26
- Deprecated something

[vNext]: https://github.com/nuke-build/nuke/compare/6.2.1...HEAD
[6.2.1]: https://github.com/nuke-build/nuke/compare/6.2.0...6.2.1
[6.2.0]: https://github.com/nuke-build/nuke/compare/0.4.0...6.2.0
[0.4.0]: https://github.com/nuke-build/nuke/compare/0.3.1...0.4.0
[0.3.1]: https://github.com/nuke-build/nuke/compare/0.2.10...0.3.1
[0.2.10]: https://github.com/nuke-build/nuke/compare/0.2.0...0.2.10
[0.2.0]: https://github.com/nuke-build/nuke/tree/0.2.0
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [vNext]

## [6.3.0] / 2022-12-12
- Added something

## [6.2.1] / 2022-08-19
- Fixed something

## [6.2.0] / 2022-08-19
- Added something

## [0.4.0] / 2018-05-02
- Deprecated something

## [0.3.1] / 2018-03-26
- Deprecated something

## [0.2.10] / 2018-03-05
- Fixed something

## [0.2.0] / 2018-02-26
- Deprecated something

[vNext]: https://github.com/nuke-build/nuke/compare/6.3.0...HEAD
[6.3.0]: https://github.com/nuke-build/nuke/compare/6.2.1...6.3.0
[6.2.1]: https://github.com/nuke-build/nuke/compare/6.2.0...6.2.1
[6.2.0]: https://github.com/nuke-build/nuke/compare/0.4.0...6.2.0
[0.4.0]: https://github.com/nuke-build/nuke/compare/0.3.1...0.4.0
[0.3.1]: https://github.com/nuke-build/nuke/compare/0.2.10...0.3.1
[0.2.10]: https://github.com/nuke-build/nuke/compare/0.2.0...0.2.10
[0.2.0]: https://github.com/nuke-build/nuke/tree/0.2.0
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# Changelog
All notable changes to this project will be documented in this file.

The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).

## [vNext]
- Added something

## [6.2.1] / 2022-08-19
- Fixed something

## [6.2.0] / 2022-08-19
- Added something

## [0.4.0] / 2018-05-02
- Deprecated something

## [0.3.1] / 2018-03-26
- Deprecated something

## [0.2.10] / 2018-03-05
- Fixed something

## [0.2.0] / 2018-02-26
- Deprecated something

[vNext]: https://github.com/nuke-build/nuke/compare/6.2.1...HEAD
[6.2.1]: https://github.com/nuke-build/nuke/compare/6.2.0...6.2.1
[6.2.0]: https://github.com/nuke-build/nuke/compare/6.1.2...6.2.0
[0.4.0]: https://github.com/nuke-build/nuke/compare/0.3.1...0.4.0
[0.3.1]: https://github.com/nuke-build/nuke/compare/0.2.10...0.3.1
[0.2.10]: https://github.com/nuke-build/nuke/compare/0.2.0...0.2.10
[0.2.0]: https://github.com/nuke-build/nuke/tree/0.2.0
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
[
{
IsEmpty: false,
Unreleased: true,
Notes: [
- Added something,

],
StartIndex: 6,
EndIndex: 8
},
{
IsEmpty: false,
Unreleased: false,
Version: 6.2.1,
Notes: [
- Fixed something,

],
StartIndex: 9,
EndIndex: 11
},
{
IsEmpty: false,
Unreleased: false,
Version: 6.2.0,
Notes: [
- Added something,

],
StartIndex: 12,
EndIndex: 14
},
{
IsEmpty: false,
Unreleased: false,
Version: 0.4.0,
Notes: [
- Deprecated something,

],
StartIndex: 15,
EndIndex: 17
},
{
IsEmpty: false,
Unreleased: false,
Version: 0.3.1,
Notes: [
- Deprecated something,

],
StartIndex: 18,
EndIndex: 20
},
{
IsEmpty: false,
Unreleased: false,
Version: 0.2.10,
Notes: [
- Fixed something,

],
StartIndex: 21,
EndIndex: 23
},
{
IsEmpty: false,
Unreleased: false,
Version: 0.2.0,
Notes: [
- Deprecated something,

],
StartIndex: 24,
EndIndex: 26
}
]