Skip to content

chore: template public API snapshot versions #238

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.

Sign up for GitHub

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

Merged
marandaneto merged 6 commits into from
Jun 22, 2026
Merged

chore: template public API snapshot versions #238

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
cafed16
chore: template public API snapshot versions
marandaneto Jun 22, 2026
6f24c7a
chore: support package-specific API version templates
marandaneto Jun 22, 2026
cea0f18
chore: add version API snapshots for all packages
marandaneto Jun 22, 2026
bcfa070
Revert "chore: add version API snapshots for all packages"
marandaneto Jun 22, 2026
fbcd331
Revert "chore: support package-specific API version templates"
marandaneto Jun 22, 2026
531539d
fix: make public API template rendering portable
marandaneto Jun 22, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 56 additions & 0 deletions Directory.Build.targets
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,56 @@
<Project>
<UsingTask TaskName="RenderPublicApiSnapshot"
TaskFactory="RoslynCodeTaskFactory"
AssemblyFile="$(MSBuildToolsPath)/Microsoft.Build.Tasks.Core.dll">
<ParameterGroup>
<SourceFile ParameterType="System.String" Required="true" />
<OutputFile ParameterType="System.String" Required="true" />
<Version ParameterType="System.String" Required="true" />
</ParameterGroup>
<Task>
<Using Namespace="System.IO" />
<Code Type="Fragment" Language="cs"><![CDATA[
var directory = Path.GetDirectoryName(OutputFile);
if (!string.IsNullOrEmpty(directory))
{
Directory.CreateDirectory(directory);
}

var text = File.ReadAllText(SourceFile).Replace("<version>", Version);
File.WriteAllText(OutputFile, text);
]]></Code>
</Task>
</UsingTask>

<!-- Render PublicAPI snapshots through a template step so version constants can use <version>. -->
<Target Name="PreparePublicApiSnapshots"
BeforeTargets="CoreCompile"
Condition="Exists('$(MSBuildProjectDirectory)/PublicAPI.Shipped.txt') Or Exists('$(MSBuildProjectDirectory)/PublicAPI.Unshipped.txt')">
<PropertyGroup>
<_PublicApiSnapshotOutputDir>$(IntermediateOutputPath)PublicApiSnapshots/</_PublicApiSnapshotOutputDir>
</PropertyGroup>

<RenderPublicApiSnapshot SourceFile="$(MSBuildProjectDirectory)/PublicAPI.Shipped.txt"
OutputFile="$(_PublicApiSnapshotOutputDir)PublicAPI.Shipped.txt"
Version="$(Version)"
Condition="Exists('$(MSBuildProjectDirectory)/PublicAPI.Shipped.txt')" />
<RenderPublicApiSnapshot SourceFile="$(MSBuildProjectDirectory)/PublicAPI.Unshipped.txt"
OutputFile="$(_PublicApiSnapshotOutputDir)PublicAPI.Unshipped.txt"
Version="$(Version)"
Condition="Exists('$(MSBuildProjectDirectory)/PublicAPI.Unshipped.txt')" />

<ItemGroup>
<AdditionalFiles Remove="PublicAPI.Shipped.txt" />
<AdditionalFiles Remove="$(MSBuildProjectDirectory)/PublicAPI.Shipped.txt" />
<AdditionalFiles Remove="PublicAPI.Unshipped.txt" />
<AdditionalFiles Remove="$(MSBuildProjectDirectory)/PublicAPI.Unshipped.txt" />

<AdditionalFiles Include="$(_PublicApiSnapshotOutputDir)PublicAPI.Shipped.txt"
Link="PublicAPI.Shipped.txt"
Condition="Exists('$(MSBuildProjectDirectory)/PublicAPI.Shipped.txt')" />
<AdditionalFiles Include="$(_PublicApiSnapshotOutputDir)PublicAPI.Unshipped.txt"
Link="PublicAPI.Unshipped.txt"
Condition="Exists('$(MSBuildProjectDirectory)/PublicAPI.Unshipped.txt')" />
</ItemGroup>
</Target>
</Project>
1 change: 1 addition & 0 deletions sdk_compliance_adapter/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@ WORKDIR /app

# Copy the solution and project files
COPY Directory.Build.props ./
COPY Directory.Build.targets ./
COPY Directory.Packages.props ./
COPY src/PostHog/PostHog.csproj src/PostHog/
COPY src/PostHog/packages.lock.json src/PostHog/
Expand Down
2 changes: 1 addition & 1 deletion src/PostHog/PublicAPI.Shipped.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -335,7 +335,7 @@ const PostHog.Api.PostHogProperties.RequestPath = "$request_path" -> string!
const PostHog.Api.PostHogProperties.ResponseStatusCode = "$response_status_code" -> string!
const PostHog.Api.PostHogProperties.SessionId = "$session_id" -> string!
const PostHog.Api.PostHogProperties.UserAgent = "$user_agent" -> string!
const PostHog.Versioning.VersionConstants.Version = "2.7.1" -> string!
const PostHog.Versioning.VersionConstants.Version = "<version>" -> string!
override PostHog.Api.ApiErrorResult.Equals(object? obj) -> bool
override PostHog.Api.ApiErrorResult.GetHashCode() -> int
override PostHog.Api.ApiErrorResult.ToString() -> string!
Expand Down
Loading