Add release automation using laminas/automatic-release #415

glensc · 2021-01-25T00:05:10Z

Use https://github.com/laminas/automatic-releases project for automating releases.

- https://github.com/laminas/automatic-releases

glensc · 2021-01-25T00:08:47Z

Currently, 0.18.0 was recently released, and 1 PR merged for 0.18.1: #413

The plan is to release 0.18.1 using this automation.

It's unclear how to test this before merging to the default branch (currently master).

As the workflows are loaded from the default branch? Perhaps should edit the default branch to be this PR's branch (releases) and close 0.18.1 milestone?

Also, as we don't maintain changelog, just drop "Bump Changelog Version On Originating Release Branch" step?

glensc · 2021-01-25T16:17:43Z

@Ocramius what do you think of this plan:

Add release automation using laminas/automatic-release #415 (comment)

as I'd avoid merging things that are not even tested and current docs offer no hints on how to test or debug.

Ocramius · 2021-01-25T16:19:03Z

Also, as we don't maintain changelog, just drop "Bump Changelog Version On Originating Release Branch" step?

If CHANGELOG.md is missing, this step will ignore everything anyway.

Ocramius · 2021-01-25T16:21:15Z

Ok, so here's what I suggest to do with the migration

merge this
git checkout master && git checkout -b 0.18.x && git push origin 0.18.x (assuming master is where you were starting from)
set 0.18.x as default branch
close the 0.18.1 milestone
profit?
delete master if no PRs reference it

In theory, that should be it 👍

glensc · 2021-01-25T16:39:11Z

I was hoping to get away with testing this before the merge. I.e assuming the workflows get activated if they are present in the default branch, i.e at the time of milestone close, the workflow file must be present on the default branch, so:

set project default branch to releases (this PR branch)
create base branch 0.18.x: g co -b 0.18.x releases && g push origin 0.18.x
set 0.18.x as default branch
close the 0.18.1 milestone
evaluate what's happening

I guess I can skip the "1", as it is changed immediately in step "3".

if everything fine:

re-open 0.18.1 milestone
merge this to master
re-create 0.18.x branch from master
delete master branch
close 0.18.1 milestone

Ocramius · 2021-01-25T16:55:28Z

The worst that can happen with this tool is publishing an erroneous tag: it does not force-push things, nor overwrites anything else, so I suggest rolling with it.

glensc · 2021-01-25T17:00:23Z

@Ocramius I do not wish to merge broken things to master, broken as in end up needing to force push master to remove commits from it. Does the test scenario I proposed works in your opinion or you see something flawed with the plan?

Ocramius · 2021-01-25T17:04:47Z

I mean, I've done the same process described at #415 (comment) with multiple dozen repositories. The upstream tool is tested at the best of my abilities and available time, but it's obviously under MIT/BSD license

If you need some sort of "dry-run" mode, that would need to be built in upstream, perhaps even with an auto-installation thingy.

I've stated the risks: now it's up to you to decide whether to merge or not, but the tool will push tags, create branches, and switch default branches :-)

glensc · 2021-01-25T17:15:49Z

I believe you had great success, and I'm not afraid tool doing something bad, but rather my setup being incomplete. Seems I'm on my own here, as you just don't want to answer.

glensc · 2021-01-25T17:30:30Z

progress

based on plan:

Add release automation using laminas/automatic-release #415 (comment)

steps:

created branch 0.18.x from branch releases
closed milestone 0.18.1
ci was fired: https://github.com/perftools/xhgui/actions/runs/509960703
... TBD

Ocramius · 2021-01-25T17:32:00Z

gpg: key 6F24A37776F19077: public key "Elan Ruusam�e <***>" imported
gpg: key 6F24A37776F19077/07E7C6216CD334B4: error sending to agent: Inappropriate ioctl for device
gpg: error reading '/tmp/imported-keyDQ3uYh': Inappropriate ioctl for device
gpg: import from '/tmp/imported-keyDQ3uYh' failed: Inappropriate ioctl for device

Seems to indicate that it tried to open TTY0, probably to ask for a password. Is the configured private key password-less?

glensc · 2021-01-25T17:39:43Z

It seems to me the password is removed, I did get an error tho:

Improve documentation for gpg subkey creation laminas/automatic-releases#102 (comment)

If I invoke 'passwd', it will only ask new password... which's a symptom of there is no prior password.

Ocramius · 2021-01-25T17:41:26Z

Perhaps @carnage can help further? I think the difference in local tooling is a bit of a barrier, and my GPG-fu isn't that strong either :-\

glensc · 2021-01-25T17:45:19Z

@Ocramius I think it may be related to the last step in readme which I did not understand and so nothing was done:

Then republish it to anywhere that you currently publish your public keys.

Here's local tester, using the file that was inserted as SIGNING_SECRET_KEY, just re-exported it

$ gpg --homedir gpg-tmp --output private-$(curdate).key --armor --export-secret-subkeys "07E7C6216CD334B4!"

➔ gpg --homedir=tmp2 '--import' private-20210125.key
gpg: keyblock resource '/Users/glen/scm/php/automatic-releases/tmp2/pubring.kbx': No such file or directory
gpg: no writable keyring found: Not found
gpg: key 6F24A37776F19077: failed to re-lookup public key: No public key
gpg: error reading 'private-20210125.key': No public key
gpg: import from 'private-20210125.key' failed: No public key
gpg: Total number processed: 0
gpg:       secret keys read: 1

gives me an indication that something related to public key is incomplete.

glensc · 2021-01-25T17:47:03Z

nevermind last comment, lack of homedir was the error source

[~/scm/php/automatic-releases (patch-3)★] ➔ mkdir tmp2

[~/scm/php/automatic-releases (patch-3)★] ➔ gpg --homedir=tmp2 --list-keys
gpg: WARNING: unsafe permissions on homedir '/Users/glen/scm/php/automatic-releases/tmp2'
gpg: keybox '/Users/glen/scm/php/automatic-releases/tmp2/pubring.kbx' created
gpg: /Users/glen/scm/php/automatic-releases/tmp2/trustdb.gpg: trustdb created

[~/scm/php/automatic-releases (patch-3)★] ➔ gpg --homedir=tmp2 --list-keys
gpg: WARNING: unsafe permissions on homedir '/Users/glen/scm/php/automatic-releases/tmp2'

[~/scm/php/automatic-releases (patch-3)★] ➔ gpg --homedir=tmp2 '--import' private-20210125.key
gpg: WARNING: unsafe permissions on homedir '/Users/glen/scm/php/automatic-releases/tmp2'
gpg: key 6F24A37776F19077: public key "Elan Ruusamäe <[email protected]>" imported
gpg: To migrate 'secring.gpg', with each smartcard, run: gpg --card-status
gpg: key 6F24A37776F19077: secret key imported
gpg: Total number processed: 1
gpg:               imported: 1
gpg:       secret keys read: 1
gpg:   secret keys imported: 1
[~/scm/php/automatic-releases (patch-3)★] ➔

glensc · 2021-01-25T17:55:30Z

Seems there's no way to retry jobs from GitHub events:

https://github.com/perftools/xhgui/runs/1763893360?check_suite_focus=true

PHP Fatal error:  Uncaught InvalidArgumentException: Could not find a value for environment variable "GITHUB_TOKEN" in /app/vendor/webmozart/assert/src/Assert.php:2042
Stack trace:
#0 /app/vendor/webmozart/assert/src/Assert.php(779): Webmozart\Assert\Assert::reportInvalidArgument()
#1 /app/vendor/webmozart/assert/src/Assert.php(69): Webmozart\Assert\Assert::notEq()
#2 /app/src/Environment/EnvironmentVariables.php(102): Webmozart\Assert\Assert::stringNotEmpty()
#3 /app/src/Environment/EnvironmentVariables.php(84): Laminas\AutomaticReleases\Environment\EnvironmentVariables::getenv()
#4 /app/bin/console.php(62): Laminas\AutomaticReleases\Environment\EnvironmentVariables::fromEnvironment()
#5 /app/bin/console.php(170): Laminas\AutomaticReleases\WebApplication\{closure}()
#6 {main}
  thrown in /app/vendor/webmozart/assert/src/Assert.php on line 2042

I just picked "re-run all ci jobs", but that retry is now run without GITHUB_TOKEN

Apparently, only way to retry a job is to toggle milestone state (open+close it)

glensc · 2021-01-25T18:04:43Z

Actually, as I'm not having any changelog, all needed steps were performed:

a release: https://github.com/perftools/xhgui/releases/tag/0.18.1 (but the commit is unverified)
a git tag, gpg signed

tag 0.18.1
Tagger: Elan Ruusamäe <[email protected]>
Date:   Mon Jan 25 17:53:40 2021 +0000

### Release Notes for [0.18.1](https://github.com/perftools/xhgui/milestone/12)

### 0.18.1

- Total issues resolved: **0**
- Total pull requests resolved: **1**
- Total contributors: **1**

 - [413: Restore flash messages](https://github.com/perftools/xhgui/pull/413) thanks to @glensc
-----BEGIN PGP SIGNATURE-----

iQGzBAABCgAdFiEEfk0uM8rm900565mcB+fGIWzTNLQFAmAPBaQACgkQB+fGIWzT
NLRZGwwAlsTaAmxDvwF7p4b2XZC2xjrXdEiGh9K7KOzv/3tdYgdQS7FgS56sPdiS
and+a6b3Qjw0ND9We6EvA7Uks1mgLH5lgPwS04hD+wxE7jxSCvNzJOeKb9wASlMB
BbYJCthWDqt45cXsHxlB7nObgpev7YS832g5duBVcbW7uXMemtUq+J+qLEN7nyb6
JdIgBVbvV5FHRDRyxkDrzwBiQDi2a4K6QQvFjVAR0JemiBmpFVXiCzduJ875Xhr1
kgg5d9u0rQ6i89CWtuX1fCNrtuXfKaU/WhGfvlPb1LfMGChKqXrVTSW+icKdfp13
OWIOmGyvHa8AlTeSszXpFaz7UV+uOnV6s3C8Au6fLS4eWBFeec3A/8bRv0v99DrI
8NdF3wROfHZjBDNoqsQ3tjs+Glhp0zYaoQyxVPtIxyuQ1Ct8W1SN4bu41t35JXev
ZkNmFmlpmi4fcuvnxDMfMEbimr61/XMlPDFx5He+JgV/07vPnMAKJorNxLCD5PqO
4o3S0aVd
=+1S+
-----END PGP SIGNATURE-----

so I'm confused about what did actually happen and what actually failed.

I've closed the 0.18.1 milestone again, new CI was launched:

https://github.com/perftools/xhgui/actions/runs/510017291

from which I see that jobs were retried when having errors?

Docker build failed with exit code 21, back off 7.545 seconds before retry. | GIT tag, release & create merge-up PR: .github#L1
-- | --
Docker build failed with exit code 21, back off 8.692 seconds before retry. | GIT tag, release & create merge-up PR: .github#L1
Ubuntu-latest workflows will use Ubuntu-20.04 soon. For more details, see https://github.com/actions/virtual-environments/issues/1816

the first run of job seems missing, i did not save the link and can't find it in navigation.

Ocramius · 2021-01-25T18:11:30Z

back-off seems to be a github internal detail.

Seems there's no way to retry jobs from GitHub events:

I generally re-open the milestone and close it again: suffices to produce a new event, and therefore run.

so I'm confused about what did actually happen and what actually failed.

The GPG signature seems valid, but you probably need to replace your GPG public key on github with one that includes your new subkey.

glensc · 2021-01-26T08:42:27Z

back-off seems to be a github internal detail.

but it's also symptom that the job was retried, as i can not find log where the tag and release were created, all i have output of failed gpg error, which right now is also unavailable as the re-run jobs made previous output unavailable (and i did not save direct link)

glensc · 2021-01-26T08:44:58Z

trying again:

deleted tag 0.18.1
deleted (now draft) release for 0.18.1
reopened and closed 0.18.1 milestone
pipeline created: https://github.com/perftools/xhgui/actions/runs/511615326
- with job https://github.com/perftools/xhgui/runs/1767897556?check_suite_focus=true

glensc · 2021-01-26T08:52:51Z

The missing gitlab token error persists, even for run created from close milestone event. previous assessment about retry job being of fault is invalid.

it succeeded Release job which apparently created git tag and github release (no such details in it's output, but visible externally)

it fails with create and/or switch release branch:

PHP Fatal error:  Uncaught InvalidArgumentException: Could not find a value for environment variable "GITHUB_TOKEN" in /app/vendor/webmozart/assert/src/Assert.php:2042
Stack trace:
#0 /app/vendor/webmozart/assert/src/Assert.php(779): Webmozart\Assert\Assert::reportInvalidArgument()
#1 /app/vendor/webmozart/assert/src/Assert.php(69): Webmozart\Assert\Assert::notEq()
#2 /app/src/Environment/EnvironmentVariables.php(102): Webmozart\Assert\Assert::stringNotEmpty()
#3 /app/src/Environment/EnvironmentVariables.php(84): Laminas\AutomaticReleases\Environment\EnvironmentVariables::getenv()
#4 /app/bin/console.php(62): Laminas\AutomaticReleases\Environment\EnvironmentVariables::fromEnvironment()
#5 /app/bin/console.php(170): Laminas\AutomaticReleases\WebApplication\{closure}()
#6 {main}
  thrown in /app/vendor/webmozart/assert/src/Assert.php on line 2042

https://github.com/perftools/xhgui/runs/1767897556?check_suite_focus=true

But wasn't GITHUB_TOKEN automatic?

https://docs.github.com/en/actions/reference/authentication-in-a-workflow

how can it go missing?

glensc · 2021-01-26T09:01:51Z

I think this is the problem, the workflow config is using org token, but I decided not to use org-wide integration:

Use GITHUB_TOKEN for standard example workflow laminas/automatic-releases#105

glensc · 2021-02-05T07:27:53Z

Added my PAT as ORGANIZATION_ADMIN_TOKEN

but "Create merge up pull request" job has failed:

https://github.com/perftools/xhgui/runs/1836977973?check_suite_focus=true

@Ocramius can you guide what failed now? or is there a way to enable more logging?

glensc · 2021-02-08T19:37:55Z

@Ocramius can you guess why it failed now?

glensc · 2021-02-12T12:14:04Z

Dunno, what failed in the previous run. I only re-run the pipeline (by deleting tag and open/close milestone) and now the pipeline succeeded without any errors:

https://github.com/perftools/xhgui/runs/1886943584?check_suite_focus=true

ait also created merge up pr successfully:

Merge release 0.18.1 into 0.19.x #417

glensc · 2021-02-12T12:32:28Z

Stupid GitHub, it closed all PR that target branch was master once I deleted master branch:

Update Slim to 3.12.3 #333 (comment)

Including in forks and fork of forks:

update from perftools duhon/xhgui#3 (a fork of https://github.com/kandy/xhgui)

Add release automation using laminas/automatic-release

c0ba6fb

- https://github.com/laminas/automatic-releases

glensc self-assigned this Jan 25, 2021

glensc mentioned this pull request Jan 26, 2021

Use GITHUB_TOKEN for standard example workflow laminas/automatic-releases#105

Closed

glensc force-pushed the releases branch from 8c9ee27 to c0ba6fb Compare February 5, 2021 07:28

glensc mentioned this pull request Feb 12, 2021

Make error of token with less privileges more human readable laminas/automatic-releases#106

Open

Set SHELL_VERBOSITY to 3

4831b29

glensc marked this pull request as ready for review February 12, 2021 12:14

glensc force-pushed the releases branch from 4580a71 to 4831b29 Compare February 12, 2021 12:17

glensc merged commit 552d0e6 into master Feb 12, 2021

glensc deleted the releases branch February 12, 2021 12:20

This was referenced Feb 12, 2021

Update Slim to 3.12.3 #333

Merged

[0.19]: Tests: Port slim.request.form_hash to _POST #414

Closed

[0.19]: change value of parameter "w" from 0 to 1 in XHGui\Saver\MongoSaver.save #358

Draft

[0.19]: Add export to cachegrind format support #302

Draft

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add release automation using laminas/automatic-release #415

Add release automation using laminas/automatic-release #415

glensc commented Jan 25, 2021

glensc commented Jan 25, 2021 •

edited

Loading

glensc commented Jan 25, 2021

Ocramius commented Jan 25, 2021

Ocramius commented Jan 25, 2021

glensc commented Jan 25, 2021

Ocramius commented Jan 25, 2021

glensc commented Jan 25, 2021

Ocramius commented Jan 25, 2021

glensc commented Jan 25, 2021

glensc commented Jan 25, 2021

Ocramius commented Jan 25, 2021

glensc commented Jan 25, 2021

Ocramius commented Jan 25, 2021

glensc commented Jan 25, 2021

glensc commented Jan 25, 2021

glensc commented Jan 25, 2021 •

edited

Loading

glensc commented Jan 25, 2021 •

edited

Loading

Ocramius commented Jan 25, 2021

glensc commented Jan 26, 2021

glensc commented Jan 26, 2021 •

edited

Loading

glensc commented Jan 26, 2021

glensc commented Jan 26, 2021

glensc commented Feb 5, 2021 •

edited

Loading

glensc commented Feb 8, 2021

glensc commented Feb 12, 2021

glensc commented Feb 12, 2021

Add release automation using laminas/automatic-release #415

Add release automation using laminas/automatic-release #415

Conversation

glensc commented Jan 25, 2021

glensc commented Jan 25, 2021 • edited Loading

glensc commented Jan 25, 2021

Ocramius commented Jan 25, 2021

Ocramius commented Jan 25, 2021

glensc commented Jan 25, 2021

Ocramius commented Jan 25, 2021

glensc commented Jan 25, 2021

Ocramius commented Jan 25, 2021

glensc commented Jan 25, 2021

glensc commented Jan 25, 2021

progress

Ocramius commented Jan 25, 2021

glensc commented Jan 25, 2021

Ocramius commented Jan 25, 2021

glensc commented Jan 25, 2021

glensc commented Jan 25, 2021

glensc commented Jan 25, 2021 • edited Loading

glensc commented Jan 25, 2021 • edited Loading

Ocramius commented Jan 25, 2021

glensc commented Jan 26, 2021

glensc commented Jan 26, 2021 • edited Loading

glensc commented Jan 26, 2021

glensc commented Jan 26, 2021

glensc commented Feb 5, 2021 • edited Loading

glensc commented Feb 8, 2021

glensc commented Feb 12, 2021

glensc commented Feb 12, 2021

glensc commented Jan 25, 2021 •

edited

Loading

glensc commented Jan 25, 2021 •

edited

Loading

glensc commented Jan 25, 2021 •

edited

Loading

glensc commented Jan 26, 2021 •

edited

Loading

glensc commented Feb 5, 2021 •

edited

Loading