docker
/
metadata-action
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #197 from crazy-max/rm-baseref-def-branch 

remove support of default branch global exp for push tag events
This commit is contained in:
CrazyMax 2022-04-26 16:08:02 +02:00 committed by GitHub
parent 0978a0678a aca951f8f5
commit 72fe50e2af
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
5 changed files with 26 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
README.md
View File

@ -676,11 +676,17 @@ Returns the base ref or target branch of the pull request that triggered the
workflow run. Will be empty for a branch reference: workflow run. Will be empty for a branch reference:
| Event | Ref | Output | | Event | Ref | Output |
|-----------------|-------------------------------|--------------------| |----------------|-------------------------------|--------------------|
| `pull_request` | `refs/pull/2/merge` | `master` | | `pull_request` | `refs/pull/2/merge` | `master` |
| `push` | `refs/heads/master` | | | `push` | `refs/heads/master` | |
| `push` | `refs/heads/my/branch` | | | `push` | `refs/heads/my/branch` | |
| `push tag` | `refs/tags/v1.2.3` | `master` | | `push tag`* | `refs/tags/v1.2.3` | `master` |
> *`base_ref` is available in the push payload but doesn't always seem to
> return the expected branch when the push tag event occurs. It's also
> [not documented in GitHub docs](https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#push).
> We keep it for backward compatibility, but it's **not recommended relying on it**.
> More context in [#192](https://github.com/docker/metadata-action/pull/192#discussion_r854673012).
#### `{{is_default_branch}}` #### `{{is_default_branch}}`
@ -688,7 +694,7 @@ Returns `true` if the branch that triggered the workflow run is the default
one, otherwise `false`. one, otherwise `false`.
Will compare against the branch name that triggered the workflow run or the Will compare against the branch name that triggered the workflow run or the
base ref or target branch for a pull request or a tag. base ref for a pull request.
#### `{{date '<format>'}}` #### `{{date '<format>'}}`

7
__tests__/meta.test.ts
View File

@ -1332,18 +1332,15 @@ describe('tag', () => {
{ {
main: 'v1.1.1-860c190-foo', main: 'v1.1.1-860c190-foo',
partial: [ partial: [
'master-foo', 'master-foo'
'defbranch-foo'
], ],
latest: false latest: false
} as Version, } as Version,
[ [
'org/app:v1.1.1-860c190-foo', 'org/app:v1.1.1-860c190-foo',
'org/app:master-foo', 'org/app:master-foo',
'org/app:defbranch-foo',
'ghcr.io/user/app:v1.1.1-860c190-foo', 'ghcr.io/user/app:v1.1.1-860c190-foo',
'ghcr.io/user/app:master-foo', 'ghcr.io/user/app:master-foo'
'ghcr.io/user/app:defbranch-foo'
], ],
[ [
"org.opencontainers.image.title=Hello-World", "org.opencontainers.image.title=Hello-World",

2
dist/index.js generated vendored
View File

File diff suppressed because one or more lines are too long

2
dist/index.js.map generated vendored
View File

File diff suppressed because one or more lines are too long

12
src/meta.ts
View File

@ -369,6 +369,8 @@ export class Meta {
if (/^refs\/tags\//.test(ctx.ref) && ctx.payload?.base_ref != undefined) { if (/^refs\/tags\//.test(ctx.ref) && ctx.payload?.base_ref != undefined) {
return ctx.payload.base_ref.replace(/^refs\/heads\//g, '').replace(/\//g, '-'); return ctx.payload.base_ref.replace(/^refs\/heads\//g, '').replace(/\//g, '-');
} }
// FIXME: keep this for backward compatibility even if doesn't always seem
// to return the expected branch. See the comment below.
if (/^refs\/pull\//.test(ctx.ref) && ctx.payload?.pull_request?.base?.ref != undefined) { if (/^refs\/pull\//.test(ctx.ref) && ctx.payload?.pull_request?.base?.ref != undefined) {
return ctx.payload.pull_request.base.ref; return ctx.payload.pull_request.base.ref;
} }
@ -376,9 +378,13 @@ export class Meta {
}, },
is_default_branch: function () { is_default_branch: function () {
let branch = ctx.ref.replace(/^refs\/heads\//g, ''); let branch = ctx.ref.replace(/^refs\/heads\//g, '');
if (/^refs\/tags\//.test(ctx.ref) && ctx.payload?.base_ref != undefined) { // TODO: "base_ref" is available in the push payload but doesn't always seem to
branch = ctx.payload.base_ref.replace(/^refs\/heads\//g, ''); // return the expected branch when the push tag event occurs. It's also not
} // documented in GitHub docs: https://docs.github.com/en/developers/webhooks-and-events/webhooks/webhook-events-and-payloads#push
// more context: https://github.com/docker/metadata-action/pull/192#discussion_r854673012
// if (/^refs\/tags\//.test(ctx.ref) && ctx.payload?.base_ref != undefined) {
// branch = ctx.payload.base_ref.replace(/^refs\/heads\//g, '');
// }
if (/^refs\/pull\//.test(ctx.ref) && ctx.payload?.pull_request?.base?.ref != undefined) { if (/^refs\/pull\//.test(ctx.ref) && ctx.payload?.pull_request?.base?.ref != undefined) {
branch = ctx.payload.pull_request.base.ref; branch = ctx.payload.pull_request.base.ref;
} }