chore: add changelogs, set up autorelease (#242)

.changelog.yml

@@ -0,0 +1,3 @@
+# Excavator auto-updates this file. Please contribute improvements to the central template.
+
+# This file is intentionally empty. The file's existence enables changelog-app and is empty to use the default configuration.

.gitignore

@@ -1,8 +1,19 @@
+# macOS
+.DS_Store
+
+# Node
 node_modules
-reports/*.xml
-packages/*/lib
-packages/*/dist
-npm-debug.log
+npm-debug.log*
+lerna-debug.log
+package-lock.json
 yarn-error.log
+
+# Documentalist
+build
+dist
+lib
+generated
+coverage
+reports/*.xml
 packages/docs/docs.json
 packages/docs/theme/version.txt

README.md

@@ -5,4 +5,26 @@
 
 > A sort-of-static site generator optimized for living documentation of software projects.
 
+### Documentation
+
 [See the full usage documentation here](https://palantir.github.io/documentalist/).
+
+### Development
+
+#### Prerequisites
+
+- Yarn v1.x
+- Node v18.x
+
+#### Dev tasks
+
+- `yarn build` compiles & builds source code
+- `yarn lint` lints source code
+- `yarn test` runs unit test suites
+- `yarn deploy` pushes docs built in the `packages/docs/dist` folder to the `gh-pages` branch
+
+#### Releases
+
+_For maintainers only_:
+
+[![Autorelease](https://img.shields.io/badge/Perform%20an-Autorelease-success.svg)](https://autorelease.general.dmz.palantir.tech/palantir/documentalist)

packages/client/changelog/@unreleased/pr-156.v2.yml

@@ -0,0 +1,5 @@
+type: feature
+feature:
+  description: Export new type alias `TsDocEntry`
+  links:
+  - https://github.com/palantir/documentalist/pull/156

packages/client/changelog/@unreleased/pr-236.v2.yml

@@ -0,0 +1,5 @@
+type: break
+break:
+  description: Upgrade minimum Node.js engine to v18.x
+  links:
+  - https://github.com/palantir/documentalist/pull/236

packages/client/changelog/@unreleased/pr-239.v2.yml

@@ -0,0 +1,38 @@
+type: break
+break:
+  description: |-
+    Rename all interfaces to drop the `I` prefix:
+    - `ICompiler` -> `Compiler`
+    - `IMetadata` -> `Metadata`
+    - `IBlock` -> `Block`
+    - `IKssModifier` -> `KssModifier`
+    - `IKSSExample` -> `KSSExample`
+    - `IKSSPluginData` -> `KSSPluginData`
+    - `IMarkdownPluginData` -> `MarkdownPluginData`
+    - `IPageNode` -> `PageNode`
+    - `IPageData` -> `PageData`
+    - `INavigable` -> `Navigable`
+    - `IHeadingNode` -> `HeadingNode`
+    - `INpmPackage` -> `NpmPackageInfo`
+    - `INpmPluginData` -> `NpmPluginData`
+    - `IPlugin` -> `Plugin`
+    - `IFile` -> `File`
+    - `ITag` -> `Tag`
+    - `IHeadingTag` -> `HeadingTag`
+    - `ITsFlags` -> `TsFlags`
+    - `ITsDocBase` -> `TsDocBase`
+    - `ITsConstructor` -> `TsConstructor`
+    - `ITsMethod` -> `TsMethod`
+    - `ITsCallable` -> `TsCallable`
+    - `ITsSignature` -> `TsSignature`
+    - `ITsDefaultValue` -> `TsDefaultValue`
+    - `ITsObjectDefinition` -> `TsObjectDefinition`
+    - `ITsProperty` -> `TsProperty`
+    - `ITsParameter` -> `TsParameter`
+    - `ITsClass` -> `TsClass`
+    - `ITsAccessor` -> `TsAccessor`
+    - `ITsEnumMember` -> `TsEnumMember`
+    - `ITsEnum` -> `TsEnum`
+    - `ITypescriptPluginData` -> `TypescriptPluginData`
+  links:
+  - https://github.com/palantir/documentalist/pull/156

packages/compiler/changelog/@unreleased/pr-156.v2.yml

@@ -0,0 +1,5 @@
+type: break
+break:
+  description: Upgrade to typedoc to v0.25.x, which supports TypeScript v4.6 - v5.2
+  links:
+  - https://github.com/palantir/documentalist/pull/156

packages/compiler/changelog/@unreleased/pr-236.v2.yml

@@ -0,0 +1,5 @@
+type: break
+break:
+  description: Upgrade minimum Node.js engine to v18.x
+  links:
+  - https://github.com/palantir/documentalist/pull/236

packages/compiler/changelog/@unreleased/pr-239.v2.yml

@@ -0,0 +1,10 @@
+type: break
+break:
+  description: |-
+    Rename all interfaces to drop the `I` prefix:
+    - `IPluginEntry` -> `PluginEntry`
+    - `IMarkdownPluginOptions` -> `MarkdownPluginOptions`
+    - `INpmPluginOptions` -> `NpmPluginOptions`
+    - `ITypescriptPluginOptions` -> `TypescriptPluginOptions`
+  links:
+  - https://github.com/palantir/documentalist/pull/156