use octokit plugin config from probot #125

jetersen · 2021-01-08T16:10:34Z

fixes #9
fixes #3

So probot's config plugin is really cool in that it supports extends which gives support for central loading of labels config.

The config plugin also allows us to load the config via api.

I implemented tests and chose to use nock as a way to avoid messing with the actual GitHub api.

You can see the use case here:
https://github.com/Specshell/.github/blob/main/.github/workflows/labels.yml
https://github.com/Specshell/.github/blob/main/.github/labels.yml
https://github.com/Specshell/specshell.software.maven.pom/blob/main/.github/workflows/labels.yml
https://github.com/Specshell/specshell.software.maven.pom/blob/main/.github/labels.yml

in the .github repo we want to have central control and using repository dispatch event we can trigger label updates when there are changes to the .github/labels.yml in .github repo

codecov · 2021-01-08T16:11:21Z

Codecov Report

Merging #125 (dc49321) into master (e3f5171) will increase coverage by 1.21%.
The diff coverage is 80.00%.

@@            Coverage Diff             @@
##           master     #125      +/-   ##
==========================================
+ Coverage   60.13%   61.34%   +1.21%     
==========================================
  Files           2        2              
  Lines         148      163      +15     
  Branches       22       26       +4     
==========================================
+ Hits           89      100      +11     
  Misses         45       45              
- Partials       14       18       +4

Impacted Files	Coverage Δ
src/labeler.ts	`59.60% <80.00%> (+1.51%)`	⬆️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update e3f5171...dc49321. Read the comment docs.

jetersen · 2021-01-08T19:45:37Z

Merging two files does work, but writing a tests for it. Proves difficult and properly needs a merging for the too labels array.

jetersen · 2021-01-08T22:43:07Z

src/labeler.ts

+        const output = [] as Label[];
+        configs
+          .map(config => {
+            let labels = config.labels ? config.labels : config;


This is needed to verify because the previous config only had an array of labels at the root.

Now if you want to use _extends and have your own labels besides those you inherit from _extends you need to have a key labels since it would not be valid yaml syntax.

jetersen · 2021-01-16T18:27:37Z

@crazy-max could you take a look?

crazy-max · 2021-01-16T18:29:20Z

@jetersen Sure, keep you in touch.

crazy-max

Thanks for this @jetersen.

Overall looks good to me but got some questions and also looks like there is output issue while printing current labels when _extends is used. Not sure if this is linked to jest or something else.

README.md

crazy-max · 2021-02-03T19:17:15Z

README.md

-      -
-        name: Checkout
-        uses: actions/checkout@v2


From what I see everything is now handled through API right? That's why checkout is not necessary anymore?

crazy-max · 2021-02-03T19:21:08Z

.res/labels.merge2.yml

@@ -0,0 +1,14 @@
+_extends: ghaction-github-labeler:.res/labels.merge1.yml


What's the context of ghaction-github-labeler:? Repo? Org?

the context is a bit odd indeed

usually you can simply refer to .github if you follow the pattern of using the same filename.
however in this case I chose to pick out the file and repo.

You can see the full regex here:
https://github.com/probot/octokit-plugin-config/blob/8443c9a4a2659f2f8661d4d496a62531edeca8ce/src/util/extends-to-get-content-params.ts#L8-L15

also docced at: https://github.com/probot/octokit-plugin-config#the-_extends-key

So the context is repo on a specific file.

You can also pull from another org as long as you have read permissions.
This is meant to satisfy a merge test.

jetersen · 2022-07-27T15:41:17Z

@crazy-max if your still interested in this.

I'll try and revive it. 😅

Looking at the action marketplace for label syncs this one is the closest to my use case and I think it still would benefit from using github api to load the yaml file and potentially deep merge with an .github org repo.

This reverts commit 3ab61b3. Throttle is not enabled by default

jetersen · 2022-07-27T21:03:47Z

@crazy-max I don't recall the issue you noticed regarding logging.

I don't see any issues locally.

Seems like you need to approve my workflows, so we could get another test run and see the output.

crazy-max · 2022-07-27T21:52:08Z

Seems like you need to approve my workflows, so we could get another test run and see the output.

Approved

if your still interested in this.

Yes I'm! Will dig this up asap thanks!

crazy-max · 2022-07-27T21:52:48Z

Looking at issues with ci, might need to rebase?

jetersen · 2022-07-27T22:05:42Z

I forgot to update the yarn lock.

I would prefer squash merge tbh.

If you want to avoid having to constantly approve my workflow you could add me with a triage permission. I think that should get past the permissions.
Although if you would like I would not mind help you maintain the action!

jetersen · 2022-07-27T22:12:10Z

src/labeler.ts

      return false;
    }
  }

  private async updateLabel(label: Label): Promise<boolean> {
    try {
-      const params = {
-        ...github.context.repo,
+      const parameters = {


fyi this are from unicorn eslint. It prefers proper naming of variables.

https://github.com/sindresorhus/eslint-plugin-unicorn

jetersen · 2022-07-27T22:17:21Z

src/labeler.ts

-        ...github.context.repo
-      })
-    ).map(label => {
+  private static remapLabels(labels: Label[]): Label[] {


not sure this is necessary though it allowed for syntax without unicorn complaining about:

https://github.com/sindresorhus/eslint-plugin-unicorn/blob/main/docs/rules/no-await-expression-member.md

although the method is only used twice so not really sure if cleans up that much.

jetersen · 2022-07-28T02:00:31Z

Running docker buildx bake validate test passes now locally as well. Sorry I was on windows, did not check with Linux 🗡️

jetersen · 2022-07-29T11:48:21Z

@crazy-max gentle reminder :)
I believe this is ready

jetersen · 2022-08-07T13:52:13Z

@crazy-max ping ☺️

jetersen · 2022-08-11T13:14:22Z

@crazy-max do you mind trigger the build or at least adding me to triage?

Or perhaps I submit another PR with small bit to get permissions. 😅

jetersen · 2022-08-11T13:40:32Z

@crazy-max created #171 to solve the permissions issue 😅

Would like to know how GitHub Action sees the test. As you mentioned you notice something off with it.

crazy-max · 2022-08-11T23:27:50Z

Can you rebase with master branch please? There are also changes that should not belong to this PR like changes with eslint, tsconfig, dependencies update or other refactoring. Can we do that in a follow-up instead. I prefer changes in a PR as focused as possible and related to the bug fix or enhancement it provides. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests. Thanks!

jetersen · 2022-08-12T05:14:16Z

@crazy-max Fair enough!

jetersen requested a review from crazy-max as a code owner January 8, 2021 16:10

jetersen force-pushed the fix/loadConfigGitHubApi branch from 5ffd82b to 8198271 Compare January 8, 2021 16:22

jetersen marked this pull request as draft January 8, 2021 19:44

jetersen marked this pull request as ready for review January 8, 2021 21:38

jetersen commented Jan 8, 2021

View reviewed changes

jetersen mentioned this pull request Jan 8, 2021

config should return undefined when object has no keys probot/octokit-plugin-config#41

Closed

crazy-max added the ✋ hold label Jan 16, 2021

crazy-max added 📌 pinned and removed ✋ hold labels Feb 3, 2021

crazy-max reviewed Feb 3, 2021

View reviewed changes

crazy-max removed the 📌 pinned label May 26, 2021

crazy-max force-pushed the master branch from 8bb70e3 to 77450f9 Compare May 26, 2022 08:23

jetersen added 8 commits July 27, 2022 18:05

use octokit plugin config from probot

4c97fa1

remove file check

881e78a

add yaml files for merging

2d699ba

add labels merge

9698f99

disable octokit throttling in tests

b0e13ea

Revert "disable octokit throttling in tests"

3826853

This reverts commit 3ab61b3. Throttle is not enabled by default

default labels to empty array

300306f

fix empty object foreach

85e00ba

jetersen force-pushed the fix/loadConfigGitHubApi branch from dc49321 to 85e00ba Compare July 27, 2022 17:09

jetersen added 4 commits July 27, 2022 19:33

update labels fixture

c9f0143

fix jest usage

60d9227

undo TOC update

f3e20c1

modernise code with unicorn

01d7b52

code cleanup

870d53c

jetersen added 4 commits July 27, 2022 23:56

eslint should ignore generated folders

44785c1

update yarn

db095d6

too much cleanup 😅

94fb804

remove repeated githubToken

2f1c081

jetersen commented Jul 27, 2022

View reviewed changes

jetersen added 3 commits July 28, 2022 00:19

keep it private readonly

1a548c5

ESMify

b019112

fix path difference in test

4cf3ff8

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

use octokit plugin config from probot #125

use octokit plugin config from probot #125

jetersen commented Jan 8, 2021 •

edited

Loading

codecov bot commented Jan 8, 2021 •

edited

Loading

jetersen commented Jan 8, 2021

jetersen Jan 8, 2021

jetersen commented Jan 16, 2021

crazy-max commented Jan 16, 2021

crazy-max left a comment •

edited

Loading

crazy-max Feb 3, 2021

jetersen Feb 3, 2021

crazy-max Feb 3, 2021

jetersen Feb 3, 2021

jetersen Jul 27, 2022

jetersen commented Jul 27, 2022

jetersen commented Jul 27, 2022

crazy-max commented Jul 27, 2022

crazy-max commented Jul 27, 2022

jetersen commented Jul 27, 2022 •

edited

Loading

jetersen Jul 27, 2022

jetersen Jul 27, 2022

jetersen commented Jul 28, 2022

jetersen commented Jul 29, 2022 •

edited

Loading

jetersen commented Aug 7, 2022

jetersen commented Aug 11, 2022 •

edited

Loading

jetersen commented Aug 11, 2022

crazy-max commented Aug 11, 2022

jetersen commented Aug 12, 2022

		@@ -0,0 +1,14 @@
		_extends: ghaction-github-labeler:.res/labels.merge1.yml

use octokit plugin config from probot #125

Are you sure you want to change the base?

use octokit plugin config from probot #125

Conversation

jetersen commented Jan 8, 2021 • edited Loading

codecov bot commented Jan 8, 2021 • edited Loading

Codecov Report

jetersen commented Jan 8, 2021

Choose a reason for hiding this comment

jetersen commented Jan 16, 2021

crazy-max commented Jan 16, 2021

crazy-max left a comment • edited Loading

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

Choose a reason for hiding this comment

jetersen commented Jul 27, 2022

jetersen commented Jul 27, 2022

crazy-max commented Jul 27, 2022

crazy-max commented Jul 27, 2022

jetersen commented Jul 27, 2022 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jetersen commented Jul 28, 2022

jetersen commented Jul 29, 2022 • edited Loading

jetersen commented Aug 7, 2022

jetersen commented Aug 11, 2022 • edited Loading

jetersen commented Aug 11, 2022

crazy-max commented Aug 11, 2022

jetersen commented Aug 12, 2022

jetersen commented Jan 8, 2021 •

edited

Loading

codecov bot commented Jan 8, 2021 •

edited

Loading

crazy-max left a comment •

edited

Loading

jetersen commented Jul 27, 2022 •

edited

Loading

jetersen commented Jul 29, 2022 •

edited

Loading

jetersen commented Aug 11, 2022 •

edited

Loading