This is an automated email from the ASF dual-hosted git repository.
tison pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/pulsar-dotpulsar.git
The following commit(s) were added to refs/heads/master by this push:
new 18f4fb8 Release process and GitHub Action to release a NuGet packages
(#184)
18f4fb8 is described below
commit 18f4fb8adcd0379c88e13003aef4c6ef6dcd17c4
Author: entvex <1580435+ent...@users.noreply.github.com>
AuthorDate: Thu Nov 2 17:11:51 2023 +0100
Release process and GitHub Action to release a NuGet packages (#184)
Co-authored-by: Zike Yang <z...@apache.org>
---
.github/workflows/publish-to-nuget.yml | 59 ++++++++
docs/release-process.md | 245 +++++++++++++++++++++++++++++++++
src/DotPulsar/DotPulsar.csproj | 9 +-
3 files changed, 311 insertions(+), 2 deletions(-)
diff --git a/.github/workflows/publish-to-nuget.yml
b/.github/workflows/publish-to-nuget.yml
new file mode 100644
index 0000000..ca79323
--- /dev/null
+++ b/.github/workflows/publish-to-nuget.yml
@@ -0,0 +1,59 @@
+#
+# Licensed to the Apache Software Foundation (ASF) under one
+# or more contributor license agreements. See the NOTICE file
+# distributed with this work for additional information
+# regarding copyright ownership. The ASF licenses this file
+# to you under the Apache License, Version 2.0 (the
+# "License"); you may not use this file except in compliance
+# with the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing,
+# software distributed under the License is distributed on an
+# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+# KIND, either express or implied. See the License for the
+# specific language governing permissions and limitations
+# under the License.
+#
+
+# Workflow to execute when a publish is made on github
https://github.com/apache/pulsar-dotpulsar/releases/new
+name: published
+
+on:
+ release:
+ types: [published]
+
+jobs:
+ build:
+ runs-on: ubuntu-latest
+ strategy:
+ fail-fast: false
+
+ steps:
+ - uses: actions/checkout@v4
+
+ - name: Set nuget package version from git tag
+ if: ${{ github.ref_type == 'tag' }}
+ env:
+ TAG: ${{ github.ref_name }}
+ run: echo "VERSION=${TAG#v}" >> $GITHUB_ENV
+
+ - name: Setup .NET
+ uses: actions/setup-dotnet@v3
+ with:
+ dotnet-version: '7.0.x'
+
+ - name: Restore dependencies
+ run: dotnet restore
+
+ - name: Build library (Release)
+ run: dotnet build --no-restore /p:PackageVersion=$VERSION -c release
src/DotPulsar/DotPulsar.csproj
+
+ - name: Create nuget package
+ run: dotnet pack /p:PackageVersion=$VERSION -c release
--include-symbols
+
+ - name: Publish the package to nuget.org
+ run: dotnet nuget push src/DotPulsar/bin/release/*.nupkg --api-key
$NUGET_AUTH_TOKEN --source https://api.nuget.org/v3/index.json
+ env:
+ NUGET_AUTH_TOKEN: ${{secret.NUGET_KEY}}
\ No newline at end of file
diff --git a/docs/release-process.md b/docs/release-process.md
new file mode 100644
index 0000000..51b5388
--- /dev/null
+++ b/docs/release-process.md
@@ -0,0 +1,245 @@
+<!--
+
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+
+-->
+
+This guide illustrates how to perform a release for Apache DotPulsar.
+
+In general, you need to perform the following steps:
+
+1. Update the version and tag of a package.
+2. Create a GitHub prerelease.
+3. Download the source code.
+4. Sign and stage the artifacts.
+5. Run a vote.
+6. Summary of vote.
+7. Promote the release.
+8. Create a GitHub release.
+9. Announce the release.
+
+#### Managing backporting of patches
+When we need to create a backporting patch, we simply create a branch for the
version that requires the backport.
+We can easily locate a specific version using git tags. We do not create a
branch until the actual need arises.
+
+### Requirements
+- [Creating GPG keys to sign release
artifacts](https://pulsar.apache.org/contribute/create-gpg-keys/)
+
+## Versioning
+Bump up the version number as follows.
+
+* Major version (e.g. 2.8.0 => 3.0.0)
+ * Changes that break backward compatibility
+* Minor version (e.g. 2.8.0 => 2.9.0)
+ * Backward compatible new features
+* Patch version (e.g. 2.8.0 => 2.8.1)
+ * Backward compatible bug fixes
+
+## Steps in detail
+
+**In these instructions, I'm referring to an fictitious release `X.X.X`.
Change the release version in the examples accordingly with the real version.**
+
+1. Update the version and tag of a package.
+
+Update the information of the new release in the `DotPulsar.csproj` and
`CHANGELOG.md` files and send a PR for with the changes.
+
+Be sure to make the commit message `Make ready for release X.X.X-rc-X`
+
+2. Create a GitHub prerelease.
+
+Browse to https://github.com/apache/pulsar-dotpulsar/releases/new
+
+Create a tag `X.X.X-rc-X`
+
+Create a release title: `DotPulsar X.X.X-rc-X`
+
+Generated release notes.
+
+Make sure the `Set as a pre-release` checkbox is checked!
+
+Publish the release.
+
+3. Download the source code.
+
+Browse to https://github.com/apache/pulsar-dotpulsar/releases to download the
source code in tar.gz.
+
+4. Sign and stage the artifacts.
+
+The src artifact need to be signed and uploaded to the dist SVN repository for
staging.
+
+```
+$ gpg -b --armor pulsar-dotpulsar-X.X.X-src.tar.gz
+$ shasum -a 512 pulsar-dotpulsar-X.X.X-src.tar.gz >
pulsar-dotpulsar-X.X.X-src.tar.gz.sha512
+```
+
+Checkout repo for uploading artifacts
+```
+$ svn co https://dist.apache.org/repos/dist/dev/pulsar pulsar-dist-dev
+$ cd pulsar-dist-dev
+```
+
+Create a candidate directory at the root repo
+```
+$ svn mkdir pulsar-dotpulsar-X.X.X-rc-1
+$ cd pulsar-dotpulsar-X.X.X-rc-1
+```
+
+Copy the signed artifacts into the rc directory and commit
+```
+$ cp ../apache-pulsar-dotpulsar-X.X.X-* .
+$ svn add *
+$ svn ci -m 'Staging artifacts and signature for DotPulsar X.X.X-rc-1'
+```
+
+5. Run a vote.
+
+Send an email to the Pulsar Dev mailing list:
+
+```
+To: d...@pulsar.apache.org
+Subject: [VOTE] DotPulsar Release X.X.X RC 1
+
+Hi everyone,
+Please review and vote on the release candidate #1 for the version X.X.X, as
follows:
+[ ] +1, Approve the release
+[ ] -1, Do not approve the release (please provide specific comments)
+
+This is the release candidate for DotPulsar, version X.X.X.
+
+DotPulsar's KEYS file contains PGP keys we used to sign this release:
+https://dist.apache.org/repos/dist/dev/pulsar/KEYS
+
+Please download these packages and review this release candidate:
+- Review release notes
+- Download the source package (verify shasum, and asc) and follow the
+README.md to build and run DotPulsar.
+
+The vote will be open for at least 72 hours. It is adopted by majority
approval, with at least 3 PMC affirmative votes.
+
+Source file:
+https://dist.apache.org/repos/dist/dev/pulsar/pulsar-dotpulsar-X.X.X-rc-1/
+
+Nuget package:
+https://www.nuget.org/packages/DotPulsar/X.X.X-rc-X
+
+The tag to be voted upon:
+X.X.X
+https://github.com/apache/pulsar-dotpulsar/tree/X.X.X-rc-X
+
+SHA-512 checksums:
+97bb1000f70011e9a585186590e0688586590e09 pulsar-dotpulsar-X.X.X-src.tar.gz
+```
+
+The vote should be open for at least 72 hours (3 days). Votes from Pulsar PMC
members will be considered binding, while anyone else is encouraged to verify
the release and vote as well.
+
+If the release is approved here, we can then proceed to the next step.
+
+6. Summary of vote.
+
+```
+To: d...@pulsar.apache.org
+Subject: [RESULT][VOTE] Apache Pulsar DotPulsar X.X.X released
+
+[RESULT][VOTE] Release Apache DotPulsar X.X.X
+
+The vote to release Apache DotPulsar X.X.X has passed.
+
+The vote PASSED with xxx binding +1 and 0 -1 votes:
+
+Binding votes:
+- Yuan Wang
+- tison
+- hulk
+- Liang Chen
+- Jean-Baptiste Onofré
+- Xiaoqiao He
+- donghui liu
+
+Vote thread:
+
+https://lists.apache.org/thread/XXX
+
+Thank you to all the above members to help us to verify and vote for the X.X.X
release.
+
+Thanks
+```
+
+7. Promote the release.
+
+Promote the artifacts on the release location (need PMC permissions):
+```
+svn move -m "release 0.X.0"
https://dist.apache.org/repos/dist/dev/pulsar/pulsar-dotpulsar-X.X.X-rc-1 \
+
https://dist.apache.org/repos/dist/release/pulsar/pulsar-dotpulsar-X.X.X
+Remove the old releases (if any). We only need the latest release there, older
releases are available through the Apache archive:
+```
+
+Get the list of releases
+```
+svn ls https://dist.apache.org/repos/dist/release/pulsar | grep dotpulsar
+```
+
+Delete each release (except for the last one)
+```
+svn rm
https://dist.apache.org/repos/dist/release/pulsar/pulsar-dotpulsar/pulsar-dotpulsar-X.X.X
+```
+
+8. Create a GitHub release.
+
+Browse to https://github.com/apache/pulsar-dotpulsar/releases/new
+
+If the head of the master branch has moved and therefore the last commit is
not named `Make ready for release X.X.X-rc-X`.
+Then change the Target from master to Recent Commits that matches `Make ready
for release X.X.X-rc-X`
+
+Create a tag `X.X.X`.
+
+Create a release title: `DotPulsar X.X.X`
+
+To Generated release notes select the 'Previous tag: X.X.X' where X.X.X is the
last non rc version.
+
+Make sure the `Set as the latest release` checkbox is checked!
+
+9. Announce the release.
+
+Once the release process is available , you can announce the release and send
an email as below:
+
+```
+To: d...@pulsar.apache.org, us...@pulsar.apache.org, annou...@apache.org
+Subject: [ANNOUNCE] Apache Pulsar C# Client DotPulsar X.X.X released
+
+The Apache Pulsar team is proud to announce DotPulsar version X.X.X.
+
+Pulsar is a highly scalable, low latency messaging platform running on
+commodity hardware. It provides simple pub-sub semantics over topics,
+guaranteed at-least-once delivery of messages, automatic cursor management for
+subscribers, and cross-datacenter replication.
+
+For Pulsar release details and downloads, visit:
+https://github.com/apache/pulsar-dotpulsar/releases/tag/X.X.X
+
+Nuget package:
+https://www.nuget.org/packages/DotPulsar/X.X.X
+
+Release Notes are at:
+https://github.com/apache/pulsar-dotpulsar/blob/master/CHANGELOG.md
+
+We would like to thank the contributors that made the release possible.
+
+Regards,
+
+The Pulsar Team
+```
diff --git a/src/DotPulsar/DotPulsar.csproj b/src/DotPulsar/DotPulsar.csproj
index a0e81e9..bed0ea2 100644
--- a/src/DotPulsar/DotPulsar.csproj
+++ b/src/DotPulsar/DotPulsar.csproj
@@ -18,17 +18,22 @@
<PublishRepositoryUrl>true</PublishRepositoryUrl>
<IncludeSymbols>true</IncludeSymbols>
<SymbolPackageFormat>snupkg</SymbolPackageFormat>
+ <EmbedUntrackedSources>true</EmbedUntrackedSources>
<NoWarn>1591</NoWarn>
</PropertyGroup>
-
+
<ItemGroup>
<PackageReference Include="HashDepot" Version="2.0.3" />
<PackageReference Include="Microsoft.Extensions.ObjectPool"
Version="7.0.12" />
- <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1"
PrivateAssets="All" />
+ <PackageReference Include="Microsoft.SourceLink.GitHub" Version="1.1.1"
PrivateAssets="All" IncludeAssets="runtime; build; native; contentfiles;
analyzers; buildtransitive" />
<PackageReference Include="protobuf-net" Version="3.2.26" />
<PackageReference Include="System.IO.Pipelines" Version="7.0.0" />
</ItemGroup>
+ <PropertyGroup Condition="'$(GITHUB_ACTIONS)' == 'true'">
+ <ContinuousIntegrationBuild>true</ContinuousIntegrationBuild>
+ </PropertyGroup>
+
<ItemGroup Condition="'$(TargetFramework)' == 'netstandard2.0'">
<PackageReference Include="Microsoft.Bcl.AsyncInterfaces" Version="7.0.0"
/>
<PackageReference Include="Microsoft.Bcl.HashCode" Version="1.1.1" />
