mirror of
https://github.com/MindWorkAI/AI-Studio.git
synced 2026-11-04 11:27:21 +00:00
Changed how pull requests bring their changes into the wiki (#1140)
This commit is contained in:
1 parent
2c2ad0dfde
commit
4522c52cba
5 files changed
+28
-18
No files matched your search
+5
-3
@@ -17,9 +17,11 @@ changelog entries.
|
||||
6. After PR merge, maintainer creates git tag: `vX.Y.Z`
|
||||
7. GitHub Actions builds release binaries for all platforms
|
||||
8. Binaries uploaded to GitHub Releases
|
||||
9. Update the wiki (`MindWorkAI/AI-Studio.wiki`): raise the version in `_Footer.md` and `de/_Footer.md`, and
|
||||
check that the user guide and the Enterprise IT pages describe the release; see "Wiki" in the root
|
||||
`AGENTS.md`
|
||||
9. Once the release is published, update the wiki (`MindWorkAI/AI-Studio.wiki`): carry the "Wiki" sections
|
||||
of the pull requests merged since the last release into it, mark what needs the new version with
|
||||
"Requires AI Studio vX.Y.Z or newer", and raise the version in `_Footer.md` and `de/_Footer.md`. The
|
||||
pull requests are listed by the command of step 2 with `--json number,title,body` and without `--jq`.
|
||||
The release command reminds you of this step when it is done.
|
||||
|
||||
## Crediting contributors
|
||||
|
||||
|
||||
@@ -46,6 +46,15 @@ public sealed partial class UpdateMetadataCommands
|
||||
await this.PerformPrepare(action, true, version);
|
||||
|
||||
await this.BuildPreparedRelease(offline);
|
||||
|
||||
// The wiki is a repository of its own, and nothing in this build touches it.
|
||||
// It describes what users can install, so it changes once the release is published:
|
||||
Console.WriteLine();
|
||||
Console.WriteLine("==============================");
|
||||
Console.WriteLine("- Warning: Remember the wiki, https://github.com/MindWorkAI/AI-Studio/wiki");
|
||||
Console.WriteLine(" Once the release is published, carry the \"Wiki\" sections of the pull requests merged since the");
|
||||
Console.WriteLine(" last release into the wiki, and raise the version in _Footer.md and de/_Footer.md. See step 9 of");
|
||||
Console.WriteLine(" \"Release Process\" in app/Build/AGENTS.md.");
|
||||
}
|
||||
|
||||
[Command("rebuild-release", Description = "Prepare & build a new build of the current release")]
|
||||
|
||||
@@ -40,7 +40,7 @@ When adding configuration plugin capabilities:
|
||||
- For managed settings, update the corresponding data class in `app/MindWork AI Studio/Settings/DataModel/` to call `ManagedConfiguration.Register(...)` and process the setting in `PluginConfiguration.TryProcessConfiguration`. Cleaning up the setting when its configuration plugin was removed needs no extra step: `ManagedConfiguration.CleanupLeftOverManagedConfigurations(...)` iterates all registered settings. Do not add per-setting cleanup calls to `PluginFactory.Loading.LoadAll`. `ManagedSettingsCoverageTests` fails for a registered setting which no configuration plugin can manage; a setting which must stay out of their reach goes into its list `EXEMPT_SETTINGS`, together with the reason.
|
||||
- For managed configuration objects, add the type to `PluginConfigurationObjectType.cs`, persist the objects in the appropriate `ConfigurationData` collection, and add a descriptor to `PluginConfigurationObjectDescriptors` and its list `ALL`: its Lua table, its parser, the collection, the next number, and where secrets are kept. Parsing and cleanup need no extra call; `PluginConfigurationObjectDescriptorsTests` fails for a type without a descriptor.
|
||||
- For live plugin content, add a data type implementing `ILivePluginContent`, parse it in `PluginConfiguration`, expose it through `PluginFactory`, and add any required cleanup only for persistent side data.
|
||||
- Always document the new capability in `app/MindWork AI Studio/Plugins/configuration/plugin.lua`, the reference of every setting, and explain it on the matching Enterprise IT page of the wiki, marked with the version which brings it; see "Wiki" in the root `AGENTS.md`.
|
||||
- Always document the new capability in `app/MindWork AI Studio/Plugins/configuration/plugin.lua`, the reference of every setting, and describe it for IT departments in the section "Wiki" of the pull request; see "Wiki" in the root `AGENTS.md`.
|
||||
|
||||
## Importing exported configuration objects
|
||||
|
||||
|
||||
Reference in new issue
Block a user