Add Chocolatey delivery Github Action #718

dfreilich · 2020-06-30T00:14:30Z

Signed-off-by: David Freilich dfreilich@vmware.com

Summary

This adds a Github Action pipeline which, upon a new release, will create and publish a Chocolatey release.

This can't be fully tested through act, unfortunately, because act doesn't yet support windows virtual environments, and the choco action (despite the promise otherwise) must be run on a windows virtual env - but I tested it on my fork here, and it worked.

Note: This will necessitate a maintainer adding a secret for the chocolatey API key (I referred to it as CHOC_KEY, but I'm happy to change that if so desired).

Documentation

Should this change be documented?
- Yes, see Add Windows installation instructions docs#7

Codecov Report

Merging #718 into release/0.12.0 will not change coverage.
The diff coverage is n/a.

@@               Coverage Diff               @@
##           release/0.12.0     #718   +/-   ##
===============================================
  Coverage           73.82%   73.82%           
===============================================
  Files                  72       72           
  Lines                5000     5000           
===============================================
  Hits                 3691     3691           
  Misses                996      996           
  Partials              313      313

Flag	Coverage Δ
#os_linux	`76.35% <ø> (ø)`
#os_macos	`72.13% <ø> (+0.05%)`	⬆️
#os_windows	`72.08% <ø> (ø)`
#unit	`73.82% <ø> (ø)`

.github/workflows/delivery/chocolatey/pack.nuspec

.github/workflows/delivery/chocolatey/tools/LICENSE.txt

dfreilich · 2020-06-30T17:59:29Z

.github/workflows/delivery-chocolatey.yml

+        run: |
+          file=${{ env.CHOC_PATH }}/pack.nuspec
+          sed -i "s/{{PACK_VERSION}}/${{ env.PACK_VERSION }}/g" $file
+          sed -i -e '/{{README}}/r README.md' -e 's/{{README}}//' $file


I use sed, rather than the replace-tokens job, because GH actions has an open issue with multiline strings, that made the formatting of the README go all wonky. See here

dfreilich · 2020-06-30T18:00:21Z

.github/workflows/delivery/chocolatey/pack.nuspec

+    <tags>pack cloud-native-buildpacks cncf</tags>
+    <summary>pack is a CLI for building apps using Cloud Native Buildpacks.</summary>
+    <description>{{README}}
+    </description>


I found that the sed wouldn't replace the {{README}} string normally if I had the description close on the same line; instead, it would insert on the next line, outside of the <description> tag entirely.

sed is more foreign to me than standard RegEx so I've avoided using it. This here just adds to my avoidance. :)

I totally agree. I just couldn't get it to work otherwise, so...

dfreilich · 2020-06-30T18:01:06Z

README.md

@@ -14,7 +14,7 @@

 ## Usage

-<img src="resources/pack-build.gif" width="600px" />
+<img src="https://github.com/buildpacks/pack/raw/main/resources/pack-build.gif" width="600px" />


I'd love to hear another suggestion if this isn't the best idea! I could also include the resource in the package, but that doesn't seem like the nicest solution, it would just needlessly clog the chocolatey package.

TLDR; Might be worth NOT posting a README.md

I'm looking around at some other packages and how this file would be used and I have a few concerns:

I haven't found that this README.md is used anywhere by another project (granted my search was quick).

How would this README be presented? If it's not and it's only listed in the files then what's its purpose?

The README.md is currently tailored to be hosted on GH. Some package registries (such as npm) do a good job about resolving links but chocolatey doesn't.

Based on the above and the added complexity/concerns, I would suggest that the <description> is sufficient from an end-user's perspective. I'm assuming it can then refer to (link) to additional details.

I'm pretty sure that this is how it gets displayed, which seems pretty visible to me: https://chocolatey.org/packages/buildpacks#description

Is there a way to confirm? If I download the nupkg. The README.md isn't there. Instead the content is in the <description> field:

To clarify what this change is about - above, we read in the README and putting it into the description tag. We don't publish a separate README file in the nupkg.

.github/workflows/delivery/chocolatey/pack.nuspec

jromero · 2020-06-30T18:16:44Z

.github/workflows/delivery/chocolatey/pack.nuspec

+    <tags>pack cloud-native-buildpacks cncf</tags>
+    <summary>pack is a CLI for building apps using Cloud Native Buildpacks.</summary>
+    <description>{{README}}
+    </description>


sed is more foreign to me than standard RegEx so I've avoided using it. This here just adds to my avoidance. :)

jromero · 2020-06-30T18:30:29Z

README.md

@@ -14,7 +14,7 @@

 ## Usage

-<img src="resources/pack-build.gif" width="600px" />
+<img src="https://github.com/buildpacks/pack/raw/main/resources/pack-build.gif" width="600px" />


TLDR; Might be worth NOT posting a README.md

I'm looking around at some other packages and how this file would be used and I have a few concerns:

I haven't found that this README.md is used anywhere by another project (granted my search was quick).

How would this README be presented? If it's not and it's only listed in the files then what's its purpose?

The README.md is currently tailored to be hosted on GH. Some package registries (such as npm) do a good job about resolving links but chocolatey doesn't.

Based on the above and the added complexity/concerns, I would suggest that the <description> is sufficient from an end-user's perspective. I'm assuming it can then refer to (link) to additional details.

jromero · 2020-07-01T21:36:46Z

NOTE: I changed the target branch for this PR in order (and hopes) that this will apply to the upcoming release. The workflows (including for the publish event) only trigger when included in the branch/commit that is tagged for release.

See: https://github.community/t/actions-not-triggered-on-release/17944/6

* Closes #703 Signed-off-by: David Freilich <dfreilich@vmware.com>

Signed-off-by: David Freilich <dfreilich@vmware.com>

* Used sed, rather than outputting the file from another job and inserting it using the tokens task, because Github Actions has an issue with multiline strings, and that would have removed formatting from it. * Use remote link for usage gif so it won't break when added to chocolatey package readme. Signed-off-by: David Freilich <dfreilich@vmware.com>

Signed-off-by: David Freilich <dfreilich@vmware.com>

* Remove changed link from README * Stop putting Readme into nuspec Signed-off-by: David Freilich <dfreilich@vmware.com>

Signed-off-by: David Freilich <dfreilich@vmware.com>

dfreilich · 2020-07-06T17:39:16Z

@jromero Just to confirm, was an API key added in under secrets for this line? https://github.com/buildpacks/pack/pull/718/files#diff-186c3d9e52fe0339dd81e7ce89864e4eR76

dfreilich requested a review from a team as a code owner June 30, 2020 00:14

jromero reviewed Jun 30, 2020

View reviewed changes

.github/workflows/delivery/chocolatey/pack.nuspec Outdated Show resolved Hide resolved

.github/workflows/delivery/chocolatey/pack.nuspec Outdated Show resolved Hide resolved

.github/workflows/delivery/chocolatey/tools/LICENSE.txt Outdated Show resolved Hide resolved

dfreilich commented Jun 30, 2020

View reviewed changes

jromero reviewed Jun 30, 2020

View reviewed changes

jromero changed the base branch from main to release/0.12.0 July 1, 2020 21:34

dfreilich force-pushed the fix/703-publish-chocolatey branch from 991b0cc to 674048b Compare July 6, 2020 15:51

jromero added this to the 0.12.0 milestone Jul 6, 2020

jromero added type/chore Issue that requests non-user facing changes. roadmap/user-onboarding Help users (end-users, contributors, etc) get started with CNB. labels Jul 6, 2020

dfreilich added 6 commits July 6, 2020 12:57

Add Chocolatey delivery Github Action

c3d853d

* Closes #703 Signed-off-by: David Freilich <dfreilich@vmware.com>

Fix triggers

7d3d199

Signed-off-by: David Freilich <dfreilich@vmware.com>

Fix mailing list url to point to url versus email list

42fd920

Signed-off-by: David Freilich <dfreilich@vmware.com>

Add Documentation information back into nuspec

e7dd96b

* Remove changed link from README * Stop putting Readme into nuspec Signed-off-by: David Freilich <dfreilich@vmware.com>

Copy license into package

9e035d4

Signed-off-by: David Freilich <dfreilich@vmware.com>

dfreilich force-pushed the fix/703-publish-chocolatey branch from 5bee25b to 9e035d4 Compare July 6, 2020 16:57

jromero approved these changes Jul 6, 2020

View reviewed changes

jromero merged commit 658c93a into release/0.12.0 Jul 6, 2020

jromero deleted the fix/703-publish-chocolatey branch July 6, 2020 17:18

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add Chocolatey delivery Github Action #718

Add Chocolatey delivery Github Action #718

dfreilich commented Jun 30, 2020 •

edited

dfreilich commented Jun 30, 2020

codecov bot commented Jun 30, 2020 •

edited

dfreilich Jun 30, 2020

dfreilich Jun 30, 2020

jromero Jun 30, 2020

dfreilich Jun 30, 2020

dfreilich Jun 30, 2020

jromero Jun 30, 2020 •

edited

dfreilich Jun 30, 2020

jromero Jun 30, 2020

dfreilich Jun 30, 2020

jromero Jun 30, 2020

jromero Jun 30, 2020 •

edited

jromero commented Jul 1, 2020

dfreilich commented Jul 6, 2020

Add Chocolatey delivery Github Action #718

Add Chocolatey delivery Github Action #718

Conversation

dfreilich commented Jun 30, 2020 • edited

Summary

Documentation

Related

dfreilich commented Jun 30, 2020

codecov bot commented Jun 30, 2020 • edited

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jromero Jun 30, 2020 • edited

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jromero Jun 30, 2020 • edited

Choose a reason for hiding this comment

jromero commented Jul 1, 2020

dfreilich commented Jul 6, 2020

dfreilich commented Jun 30, 2020 •

edited

codecov bot commented Jun 30, 2020 •

edited

jromero Jun 30, 2020 •

edited

jromero Jun 30, 2020 •

edited