Octobot/TeamOctolings.Octobot/BuildInfo.cs

namespace TeamOctolings.Octobot;

public static class BuildInfo
{
    public const string RepositoryUrl = "https://github.com/TeamOctolings/Octobot";

    public const string IssuesUrl = $"{RepositoryUrl}/issues";

    public const string WikiUrl = $"{RepositoryUrl}/wiki";

    private const string Commit = ThisAssembly.Git.Commit;

    private const string Branch = ThisAssembly.Git.Branch;

    public static bool IsDirty => ThisAssembly.Git.IsDirty;

    public static string Version => IsDirty ? $"{Branch}-{Commit}-dirty" : $"{Branch}-{Commit}";
}
-												Apply official naming guidelines to Octobot (#306)

1. The root namespace was changed from `Octobot` to
`TeamOctolings.Octobot`:
> DO prefix namespace names with a company name to prevent namespaces
from different companies from having the same name.
2. `Octobot.cs` was renamed to `Program.cs`:
> DO NOT use the same name for a namespace and a type in that namespace.
3. `IOption`, `Option` were renamed to `IGuildOption` and `GuildOption`
respectively:
> DO NOT introduce generic type names such as Element, Node, Log, and
Message.
4. `Utility` was moved out of the `Services` namespace. It didn't belong
there anyway
5. `Program` static fields were moved to `Utility`
6. Localisation files were moved back to the project source files. Looks
like this fixed `Message.Designer.cs` code generation

---------

Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com>
											
										
										
											2024-05-16 18:34:26 +03:00
+								namespace TeamOctolings.Octobot;
-												Add GitInfo NuGet package (#268)

In this PR, I added a NuGet package called GitInfo. It can replace
Octobot.RepositoryUrl and display the bot version as the current branch
and commit.

---------

Signed-off-by: mctaylors <cantsendmails@mctaylors.ru>
Signed-off-by: Macintxsh <95250141+mctaylors@users.noreply.github.com>
											
										
										
											2024-03-19 20:51:32 +03:00
 								public static class BuildInfo
 								{
-												fix: do not use RepositoryUrl from GitInfo (#287)

GitInfo's `RepositoryUrl` string depends on origin URL, which is
unvalidated user input that isn't even guaranteed to exist. This can
cause issues that are almost impossible to
debug

Closes #281
											
										
										
											2024-03-24 15:39:26 +03:00
+								    public const string RepositoryUrl = "https://github.com/TeamOctolings/Octobot";
-												Add GitInfo NuGet package (#268)

In this PR, I added a NuGet package called GitInfo. It can replace
Octobot.RepositoryUrl and display the bot version as the current branch
and commit.

---------

Signed-off-by: mctaylors <cantsendmails@mctaylors.ru>
Signed-off-by: Macintxsh <95250141+mctaylors@users.noreply.github.com>
											
										
										
											2024-03-19 20:51:32 +03:00
-												fix: do not use RepositoryUrl from GitInfo (#287)

GitInfo's `RepositoryUrl` string depends on origin URL, which is
unvalidated user input that isn't even guaranteed to exist. This can
cause issues that are almost impossible to
debug

Closes #281
											
										
										
											2024-03-24 15:39:26 +03:00
+								    public const string IssuesUrl = $"{RepositoryUrl}/issues";
-												Add GitInfo NuGet package (#268)

In this PR, I added a NuGet package called GitInfo. It can replace
Octobot.RepositoryUrl and display the bot version as the current branch
and commit.

---------

Signed-off-by: mctaylors <cantsendmails@mctaylors.ru>
Signed-off-by: Macintxsh <95250141+mctaylors@users.noreply.github.com>
											
										
										
											2024-03-19 20:51:32 +03:00
-												fix: do not use RepositoryUrl from GitInfo (#287)

GitInfo's `RepositoryUrl` string depends on origin URL, which is
unvalidated user input that isn't even guaranteed to exist. This can
cause issues that are almost impossible to
debug

Closes #281
											
										
										
											2024-03-24 15:39:26 +03:00
+								    public const string WikiUrl = $"{RepositoryUrl}/wiki";
-												Pre-Wiki Update (#285)

This PR has been opened to finally update Octobot's Wiki.

Current changes summary:
- correct minor spelling issues in some command descriptions
- /about: add Octobot's Wiki button

---------

Signed-off-by: mctaylors <cantsendmails@mctaylors.ru>
											
										
										
											2024-03-23 21:45:39 +03:00
-												fix: do not use RepositoryUrl from GitInfo (#287)

GitInfo's `RepositoryUrl` string depends on origin URL, which is
unvalidated user input that isn't even guaranteed to exist. This can
cause issues that are almost impossible to
debug

Closes #281
											
										
										
											2024-03-24 15:39:26 +03:00
+								    private const string Commit = ThisAssembly.Git.Commit;
-												Add GitInfo NuGet package (#268)

In this PR, I added a NuGet package called GitInfo. It can replace
Octobot.RepositoryUrl and display the bot version as the current branch
and commit.

---------

Signed-off-by: mctaylors <cantsendmails@mctaylors.ru>
Signed-off-by: Macintxsh <95250141+mctaylors@users.noreply.github.com>
											
										
										
											2024-03-19 20:51:32 +03:00
-												fix: do not use RepositoryUrl from GitInfo (#287)

GitInfo's `RepositoryUrl` string depends on origin URL, which is
unvalidated user input that isn't even guaranteed to exist. This can
cause issues that are almost impossible to
debug

Closes #281
											
										
										
											2024-03-24 15:39:26 +03:00
+								    private const string Branch = ThisAssembly.Git.Branch;
-												Add GitInfo NuGet package (#268)

In this PR, I added a NuGet package called GitInfo. It can replace
Octobot.RepositoryUrl and display the bot version as the current branch
and commit.

---------

Signed-off-by: mctaylors <cantsendmails@mctaylors.ru>
Signed-off-by: Macintxsh <95250141+mctaylors@users.noreply.github.com>
											
										
										
											2024-03-19 20:51:32 +03:00
-												Allow using expression-bodied properties (#280)

This change significantly reduces the code space used by properties
while maintaining clarity on types. Since only properties are allowed to
use expression bodies, it is clear to developers that what they are
looking at is a property or not

Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com>
											
										
										
											2024-03-20 19:08:59 +03:00
+								    public static bool IsDirty => ThisAssembly.Git.IsDirty;
-												Add GitInfo NuGet package (#268)

In this PR, I added a NuGet package called GitInfo. It can replace
Octobot.RepositoryUrl and display the bot version as the current branch
and commit.

---------

Signed-off-by: mctaylors <cantsendmails@mctaylors.ru>
Signed-off-by: Macintxsh <95250141+mctaylors@users.noreply.github.com>
											
										
										
											2024-03-19 20:51:32 +03:00
-												Allow using expression-bodied properties (#280)

This change significantly reduces the code space used by properties
while maintaining clarity on types. Since only properties are allowed to
use expression bodies, it is clear to developers that what they are
looking at is a property or not

Signed-off-by: Octol1ttle <l1ttleofficial@outlook.com>
											
										
										
											2024-03-20 19:08:59 +03:00
+								    public static string Version => IsDirty ? $"{Branch}-{Commit}-dirty" : $"{Branch}-{Commit}";
-												Add GitInfo NuGet package (#268)

In this PR, I added a NuGet package called GitInfo. It can replace
Octobot.RepositoryUrl and display the bot version as the current branch
and commit.

---------

Signed-off-by: mctaylors <cantsendmails@mctaylors.ru>
Signed-off-by: Macintxsh <95250141+mctaylors@users.noreply.github.com>
											
										
										
											2024-03-19 20:51:32 +03:00
+								}