feat: GitHub Action customizations #382

dnys1 · 2022-05-13T00:01:15Z

Adds support for an action block which can be attached to tasks to specify GitHub Action context, e.g. uses, with, etc. Instead of a separate block, this config could be in-lined but I wasn't sure if that was in keeping with the library, since providers other than GitHub are supported.

stages:
  - custom_step:
      - command:
          - ./script_a
          - ./script_b
          - ./script_c
        action:
          id: custom-scripts
          uses: ./.github/actions/my-action
          with:
            my-key: my-var
          if: always()
          working-directory: ./tool
          shell: fish

These are just some thoughts - looking forward to your feedback!

kevmoo · 2022-05-13T04:19:28Z

thoughts @jakemac53 @natebosch ?

jakemac53 · 2022-05-13T15:13:30Z

mono_repo/lib/src/commands/github/github_yaml.dart

+          '$package; ${task.command}',
+          _commandForOs(task.command),
+          id: task.action?.id,
+          ifCondition: task.action?.condition ??


I think we should likely add the && steps.$pubStepId.conclusion == 'success' no matter what?

Sounds good to me. I agree that in most cases, this is the desired behavior, and for the few "failure-only" scripts you may want to run, they can be handled via the on_completion task.

jakemac53 · 2022-05-13T15:15:23Z

mono_repo/lib/src/commands/github/github_yaml.dart

-          workingDirectory: package,
+          '$package; ${task.command}',
+          _commandForOs(task.command),
+          id: task.action?.id,


I am a bit concerned with hard coding all the supported fields we allow overriding here.

Would it be reasonable to just treat this as a more opaque override map? I don't think we want to be fielding feature requests/prs for every thing people end up wanting to override here.

That's a good question. At that point, does it make sense for action to function more similar to command and spread its JSON into the GitHub action yaml so that, for example, overriding run becomes possible? Right now, the following is unclear in my mind:

stages: - custom_step: - command: ./script_a action: run: ./script_b

But this could possibly make more sense:

stages: - custom_step: - action: run: ./script_b

Yeah, possibly just allowing a fully custom action task would make the most sense? I kind of like that.

Sweet! I’ll work on updating it 👍

Okay, so I've made the following changes:

action now functions similar to command as a top level step type

Consolidated GitHub action config into the GitHubActionConfig class since there was a lot of overlap with _CommandEntry

Added some validators for known GitHub step config keys (run, uses, with, etc.) but allows for unknown keys to be used as well. Let me know if these helpers are useful or if we should just dump whatever we're given. There is the possibility for things to change, and the flipside is that I think it offers a bit nicer DX than discovering a typo down the road.

dnys1 · 2022-05-21T20:32:34Z

Hey @jakemac53 - still feeling like this is a good direction? I've updated the action specifier to behave like command as noted above.

jakemac53 · 2022-05-26T15:44:19Z

cc @natebosch or @kevmoo opinions here?

mono_repo/lib/src/package_config.dart

kevmoo · 2022-06-23T20:44:43Z

We want to land this? @jakemac53 ?

kevmoo · 2022-07-11T20:52:36Z

@dnys1 – you'll need to rebase this work on latest. Sorry!

dnys1 · 2022-07-16T19:31:20Z

Hey @kevmoo, no worries and thanks for the heads up. I've rebased off the latest changes.

coveralls · 2022-07-18T19:47:20Z

Pull Request Test Coverage Report for Build 2693092847

102 of 116 (87.93%) changed or added relevant lines in 6 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage decreased (-0.2%) to 83.912%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
mono_repo/lib/src/commands/github/step.g.dart	11	12	91.67%
mono_repo/lib/src/package_config.dart	5	6	83.33%
mono_repo/lib/src/github_config.dart	38	50	76.0%

Totals
Change from base Build 2679237497:	-0.2%
Covered Lines:	1304
Relevant Lines:	1554

💛 - Coveralls

coveralls · 2022-07-18T19:47:22Z

Pull Request Test Coverage Report for Build 2693043484

101 of 115 (87.83%) changed or added relevant lines in 6 files are covered.
2 unchanged lines in 1 file lost coverage.
Overall coverage decreased (-0.2%) to 83.912%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
mono_repo/lib/src/commands/github/step.g.dart	11	12	91.67%
mono_repo/lib/src/package_config.dart	5	6	83.33%
mono_repo/lib/src/github_config.dart	38	50	76.0%

Files with Coverage Reduction	New Missed Lines	%
mono_repo/lib/src/task_type.dart	2	93.94%

Totals
Change from base Build 2679237497:	-0.2%
Covered Lines:	1304
Relevant Lines:	1554

💛 - Coveralls

codecov-commenter · 2022-07-18T19:50:47Z

Codecov Report

Merging #382 (bc155cb) into master (53aa5b2) will decrease coverage by 76.96%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##           master    #382       +/-   ##
==========================================
- Coverage   84.10%   7.13%   -76.97%     
==========================================
  Files          34      34               
  Lines        1453    1555      +102     
==========================================
- Hits         1222     111     -1111     
- Misses        231    1444     +1213

Impacted Files	Coverage Δ
mono_repo/lib/src/commands/github/github_yaml.dart	`0.00% <0.00%> (-96.70%)`	⬇️
mono_repo/lib/src/commands/github/step.dart	`0.00% <0.00%> (-100.00%)`	⬇️
mono_repo/lib/src/commands/github/step.g.dart	`0.00% <0.00%> (-100.00%)`	⬇️
mono_repo/lib/src/github_config.dart	`0.00% <0.00%> (-98.37%)`	⬇️
mono_repo/lib/src/package_config.dart	`0.00% <0.00%> (-95.63%)`	⬇️
mono_repo/lib/src/task_type.dart	`10.60% <0.00%> (-82.62%)`	⬇️
mono_repo/lib/src/raw_config.g.dart	`0.00% <0.00%> (-100.00%)`	⬇️
mono_repo/lib/src/mono_config.g.dart	`0.00% <0.00%> (-100.00%)`	⬇️
mono_repo/lib/src/ci_test_script.dart	`0.00% <0.00%> (-100.00%)`	⬇️
mono_repo/lib/src/package_config.g.dart	`0.00% <0.00%> (-100.00%)`	⬇️
... and 26 more

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 53aa5b2...bc155cb. Read the comment docs.

Two issues fixed: 1. `name` overrides were not being passed correctly to methods/ctors - whoops! 2. Default `name` should consider either `run` or `uses` depending on which is passed.

provokateurin · 2022-09-25T00:49:42Z

Hi, any plans to continue this? I would love to have this feature implemented.

jakemac53 reviewed May 13, 2022

View reviewed changes

jakemac53 reviewed May 26, 2022

View reviewed changes

mono_repo/lib/src/package_config.dart Outdated Show resolved Hide resolved

natebosch mentioned this pull request Jun 21, 2022

Allow integration with melos #396

Open

Dillon Nys added 6 commits July 12, 2022 07:53

feat: GitHub Action customizations

0ee8514

chore: Refine inputs type

cba6118

chore: Add pub step check to custom if

4f16960

Migrate to top-level action

e325c69

Rename action to github_action

248eee8

Fix tests

f200385

dnys1 force-pushed the feat/actions-config branch from 2fc2ce6 to f200385 Compare July 16, 2022 19:22

Dillon Nys added 2 commits July 16, 2022 12:28

Clean up

524502e

Merge remote-tracking branch 'google/master' into feat/actions-config

9b8588c

Dillon Nys and others added 2 commits July 18, 2022 06:23

Add missing license header

b4af2ae

fix for CI

860bc7a

kevmoo force-pushed the feat/actions-config branch 2 times, most recently from dc5436d to bc155cb Compare July 18, 2022 19:47

revert type change to withContent

db9505a

kevmoo force-pushed the feat/actions-config branch from bc155cb to db9505a Compare July 18, 2022 19:52

Fix naming

9ad3d97

Two issues fixed: 1. `name` overrides were not being passed correctly to methods/ctors - whoops! 2. Default `name` should consider either `run` or `uses` depending on which is passed.

feat: GitHub Action customizations #382

Are you sure you want to change the base?

feat: GitHub Action customizations #382

Uh oh!

Conversation

dnys1 commented May 13, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

kevmoo commented May 13, 2022

Uh oh!

jakemac53 May 13, 2022

Choose a reason for hiding this comment

Uh oh!

dnys1 May 13, 2022

Choose a reason for hiding this comment

Uh oh!

jakemac53 May 13, 2022

Choose a reason for hiding this comment

Uh oh!

dnys1 May 13, 2022

Choose a reason for hiding this comment

Uh oh!

jakemac53 May 13, 2022

Choose a reason for hiding this comment

Uh oh!

dnys1 May 13, 2022

Choose a reason for hiding this comment

Uh oh!

dnys1 May 15, 2022

Choose a reason for hiding this comment

Uh oh!

dnys1 commented May 21, 2022

Uh oh!

jakemac53 commented May 26, 2022

Uh oh!

Uh oh!

kevmoo commented Jun 23, 2022

Uh oh!

kevmoo commented Jul 11, 2022

Uh oh!

dnys1 commented Jul 16, 2022

Uh oh!

coveralls commented Jul 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Pull Request Test Coverage Report for Build 2693092847

💛 - Coveralls

Uh oh!

coveralls commented Jul 18, 2022

Pull Request Test Coverage Report for Build 2693043484

💛 - Coveralls

Uh oh!

codecov-commenter commented Jul 18, 2022 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

provokateurin commented Sep 25, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

dnys1 commented May 13, 2022 •

edited

Loading

coveralls commented Jul 18, 2022 •

edited

Loading

codecov-commenter commented Jul 18, 2022 •

edited

Loading