AppVeyor deployment enhancements #2185

JohnTheGr8 · 2023-06-12T20:32:57Z

Starting a PR following the discussion in #2086

with this modified setup:

on commit to master (ie when a release PR is merged), AppVeyor will:
a. create a draft release on the main repository
b. publish a release on the Prereleases repository (otherwise it falls behind when a stable version is published)
the draft release gets reviewed & tested, release notes are written
when the app is ready, the draft release can be published (manually). This should:
a. trigger the WinGet release action
b. create the git tag, which will trigger an AppVeyor build that will only deploy the Flow.Launcher.Plugin package to nuget (when it has been changed)

Some notes:

releases are only published once (manually), never force-updated from a CI job... should resolve BUG: WinGet release uploads with the wrong hash #2086
during step 2, hot-fixes can be applied to the master branch, without bumping the app version.
the build-on-tag is still used for pushing to nuget, because:
1. we don't really care if it takes a few minutes more to deploy to nuget
2. we want deployment to nuget to be the final step in the release process
3. nuget packages are immutable: if we published on commit to master, we wouldn't be able to support hot-fixes

sanity testing is still TODO but let me know what you think

* create draft release on commit (not tag) to master * do not force_update existing releases

`prereleaseTag` was being defined as `APPVEYOR_BUILD_VERSION`

Add a new deploy target that is triggered when we merge to master and creates a release on the `Prereleases` repository with the same artifacts as the upcoming main release.

github-actions · 2023-06-12T20:33:59Z

@check-spelling-bot Report

🔴 Please review

See the 📂 files view or the 📜action log for details.

Unrecognized words (2)

Prereleases
Veyor

To accept ✔️ these unrecognized words as correct and remove the previously acknowledged and now absent words, run the following commands

... in a clone of the git@github.com:JohnTheGr8/Flow.Launcher.git repository
on the appveyor_deployment_enhancements branch (ℹ️ how do I use this?):

curl -s -S -L 'https://raw.githubusercontent.com/check-spelling/check-spelling/main/apply.pl' |
perl - 'https://github.com/Flow-Launcher/Flow.Launcher/actions/runs/5248266836/attempts/1'

If the flagged items are 🤯 false positives

If items relate to a ...

binary file (or some other file you wouldn't want to check at all).

Please add a file path to the excludes.txt file matching the containing file.

File paths are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your files.

^ refers to the file's path from the root of the repository, so ^README\.md$ would exclude README.md (on whichever branch you're using).
well-formed pattern.

If you can write a pattern that would match it,
try adding it to the patterns.txt file.

Patterns are Perl 5 Regular Expressions - you can test yours before committing to verify it will match your lines.

Note that patterns can't match multiline strings.

jjw24 · 2023-06-26T23:06:01Z

appveyor.yml

-      if ($env:APPVEYOR_REPO_BRANCH -eq "dev")
-      {
-        $env:prereleaseTag = "{0}.{1}.{2}.{3}" -f $version.Major, $version.Minor, $version.Build, $version.Revision
-      }


Why is this removed? We need to add the revision version for prereleases.

not removed, just replaced with $APPVEYOR_BUILD_VERSION, they are exactly the same

That's fine make sure you test it, if I remember correctly when I updated this, that pipeline variable returned only the build number part of the version.

Also we want revision number too not just the build number.

see line 5 above, $env:prereleaseTag was derived from $env:APPVEYOR_BUILD_VERSION

jjw24 · 2023-06-26T23:13:13Z

appveyor.yml

    force_update: true
    on:
      branch: master
+      APPVEYOR_REPO_TAG: false


Is this needed? Does this mean trigger on master or non-tagged builds?

What I want is for it to trigger on master & tag, but I need to test to make sure that's how it behaves

If I am not mistaking, I think you are trying to cover a scenario (doing a hot fix during a release) that has never happened. We have had several times where we needed to immediately rollout a hot fix after a release, but never during.

Assuming a tag is only created after setting the draft release to latest, you can just cater for:

Merge to master -> draft release, so 'on master' condition

Setting draft release to latest -> trigger 'on tag' -> publish NuGet and Prerelease

I think this is a simpler pipeline process. Any hot fixes we just do a new release. If we need to really hot fix during a release, I can just delete draft release, then merge hot fix in, which will kick off the above process again.

You will find testing this is a painful process because our build & test takes a while, recommend fork the project and the prerelease project, comment out the unit test code and test that way. Also I might be wrong but off the top of my head I think the 'on' condition you got is 'master' or 'tag is false'.

If I am not mistaking, I think you are trying to cover a scenario (doing a hot fix during a release) that has never happened. We have had several times where we needed to immediately rollout a hot fix after a release, but never during.

I am not trying to cover that scenario, really... it just happens to be possible with this setup, so I'm spelling it out.

Assuming a tag is only created after setting the draft release to latest, you can just cater for:

Merge to master -> draft release, so 'on master' condition

Setting draft release to latest -> trigger 'on tag' -> publish NuGet and Prerelease

so you suggest that we push to Prereleases when APPVEYOR_REPO_TAG: true right?

Also I might be wrong but off the top of my head I think the 'on' condition you got is 'master' or 'tag is false'.

yeah it could be so, I'll define a different env variable for this to be sure

so you suggest that we push to Prereleases when APPVEYOR_REPO_TAG: true right?

Yeah. I don't think it matters if it's pushed on merge to master or when APPVEYOR_REPO_TAG: true. If on merge to master you can set force push to true so hot fix during a release will still update the prerelease artefacts.

release artifacts wont be exactly the same but that's no big deal

jjw24 · 2023-06-26T23:14:45Z

appveyor.yml

    on:
-      APPVEYOR_REPO_TAG: true
+      branch: master
+      APPVEYOR_REPO_TAG: false


Same as above comment

appveyor.yml

JohnTheGr8 added 3 commits June 11, 2023 22:25

appveyor: update github release deployment

ddf9b49

* create draft release on commit (not tag) to master * do not force_update existing releases

appveyor: refactor pre-release version value

3969e11

`prereleaseTag` was being defined as `APPVEYOR_BUILD_VERSION`

appveyor: deploy RCs to the Prereleases repo

be97675

Add a new deploy target that is triggered when we merge to master and creates a release on the `Prereleases` repository with the same artifacts as the upcoming main release.

JohnTheGr8 added the CI/CD label Jun 12, 2023

JohnTheGr8 requested review from Garulf, jjw24 and taooceros June 12, 2023 20:32

JohnTheGr8 self-assigned this Jun 12, 2023

jjw24 marked this pull request as ready for review June 26, 2023 12:40

jjw24 marked this pull request as draft June 26, 2023 12:41

jjw24 added the bug Something isn't working label Jun 26, 2023

jjw24 reviewed Jun 26, 2023

View reviewed changes

appveyor.yml Show resolved Hide resolved

jjw24 mentioned this pull request Jul 4, 2023

Fix artefact hash discrepancy for WinGet release #2218

Closed

github-actions bot added the no-pr-activity label Aug 13, 2023

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

AppVeyor deployment enhancements #2185

AppVeyor deployment enhancements #2185

JohnTheGr8 commented Jun 12, 2023

github-actions bot commented Jun 12, 2023

jjw24 Jun 26, 2023

JohnTheGr8 Jun 27, 2023

jjw24 Jun 27, 2023

jjw24 Jun 27, 2023 •

edited

JohnTheGr8 Jun 27, 2023

jjw24 Jun 26, 2023

JohnTheGr8 Jun 27, 2023

jjw24 Jun 28, 2023

JohnTheGr8 Jun 28, 2023 •

edited

jjw24 Jun 28, 2023

JohnTheGr8 Jun 28, 2023

jjw24 Jun 26, 2023

AppVeyor deployment enhancements #2185

Are you sure you want to change the base?

AppVeyor deployment enhancements #2185

Conversation

JohnTheGr8 commented Jun 12, 2023

github-actions bot commented Jun 12, 2023

@check-spelling-bot Report

🔴 Please review

Unrecognized words (2)

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jjw24 Jun 27, 2023 • 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

JohnTheGr8 Jun 28, 2023 • 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

jjw24 Jun 27, 2023 •

edited

JohnTheGr8 Jun 28, 2023 •

edited