feature: build overrides (#2212)
* add build overrides * override docs * add server submodule * add overrides to build step * remove testing api url Co-Authored-By: Quahu <quahuu@gmail.com> Co-authored-by: Quahu <quahuu@gmail.com>
This commit is contained in:
41
docs/faq/build_overrides/what-are-they.md
Normal file
41
docs/faq/build_overrides/what-are-they.md
Normal file
@@ -0,0 +1,41 @@
|
||||
---
|
||||
uid: FAQ.BuildOverrides.WhatAreThey
|
||||
title: Build Overrides, What are they?
|
||||
---
|
||||
|
||||
# Build Overrides
|
||||
|
||||
Build overrides are a way for library developers to override the default behavior of the library on the fly. Adding them to your code is really simple.
|
||||
|
||||
## Installing the package
|
||||
|
||||
The build override package can be installed on nuget [here](TODO) or by using the package manager
|
||||
|
||||
```
|
||||
PM> Install-Package Discord.Net.BuildOverrides
|
||||
```
|
||||
|
||||
## Adding an override
|
||||
|
||||
```cs
|
||||
public async Task MainAsync()
|
||||
{
|
||||
// hook into the log function
|
||||
BuildOverrides.Log += (buildOverride, message) =>
|
||||
{
|
||||
Console.WriteLine($"{buildOverride.Name}: {message}");
|
||||
return Task.CompletedTask;
|
||||
};
|
||||
|
||||
// add your overrides
|
||||
await BuildOverrides.AddOverrideAsync("example-override-name");
|
||||
}
|
||||
|
||||
```
|
||||
|
||||
Overrides are normally built for specific problems, for example if someone is having an issue and we think we might have a fix then we can create a build override for them to test out the fix.
|
||||
|
||||
## Security and Transparency
|
||||
|
||||
Overrides can only be created and updated by library developers, you should only apply an override if a library developer askes you to.
|
||||
Code for the overrides server and the overrides themselves can be found [here](https://github.com/discord-net/Discord.Net.BuildOverrides).
|
||||
@@ -22,3 +22,5 @@
|
||||
topicUid: FAQ.TextCommands.General
|
||||
- name: Legacy or Upgrade
|
||||
topicUid: FAQ.Legacy
|
||||
- name: Build Overrides
|
||||
topicUid: FAQ.BuildOverrides.WhatAreThey
|
||||
|
||||
Reference in New Issue
Block a user