feat: Add Github Actions support #717

Hawkurane · 2022-02-14T16:25:20Z

Fixes #422

You can do:

POST /api/projects/init
POST /api/github-actions/init

codecov · 2022-02-14T16:39:27Z

Codecov Report

Merging #717 (3b26f40) into main (6d005dc) will not change coverage.
The diff coverage is 100.00%.

@@             Coverage Diff             @@
##                main      #717   +/-   ##
===========================================
  Coverage     100.00%   100.00%           
- Complexity      1312      1321    +9     
===========================================
  Files            247       251    +4     
  Lines           4101      4124   +23     
  Branches          71        71           
===========================================
+ Hits            4101      4124   +23

Impacted Files	Coverage Δ
...s/application/GithubActionsApplicationService.java	`100.00% <100.00%> (ø)`
...thubactions/domain/GithubActionsDomainService.java	`100.00% <100.00%> (ø)`
...ructure/config/GithubActionsBeanConfiguration.java	`100.00% <100.00%> (ø)`
...astructure/primary/rest/GithubActionsResource.java	`100.00% <100.00%> (ø)`
...infrastructure/primary/rest/SpringDocResource.java
...ngdoc/application/SpringDocApplicationService.java
...ver/springboot/mvc/springdoc/domain/SpringDoc.java
...t/mvc/springdoc/domain/SpringDocDomainService.java
...rastructure/config/SpringDocBeanConfiguration.java
...ver/springboot/mvc/springdoc/domain/Springdoc.java	`100.00% <0.00%> (ø)`
... and 4 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 6d005dc...3b26f40. Read the comment docs.

pascalgrimaud · 2022-02-14T19:19:31Z

...pster/lite/generator/githubactions/infrastructure/config/GithubActionsBeanConfiguration.java

+
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.objenesis.SpringObjenesis;


Strange import

pascalgrimaud · 2022-02-14T19:20:12Z

...jhipster/lite/generator/githubactions/infrastructure/primary/rest/GithubActionsResource.java

+  @Operation(summary = "Init Github Actions YML file")
+  @ApiResponse(responseCode = "500", description = "An error occurred while initializing the github-actions.yml.mustache file")
+  @PostMapping("/init")
+  @GeneratorStep(id = "init")


Should be github-actions, as init is already used

pascalgrimaud · 2022-02-14T19:22:29Z

src/main/java/tech/jhipster/lite/generator/githubactions/domain/GithubActionsDomainService.java

+
+  @Override
+  public void addYml(Project project) {
+    projectRepository.template(project, SOURCE, GITHUB_ACTIONS_YML, GITHUB_ACTIONS_FOLDER);


You forgot to add setup config
See https://github.com/jhipster/jhipster-lite/blob/main/.github/actions/setup/action.yml

pascalgrimaud · 2022-02-14T19:24:24Z

You could add the api to one of config, in generate.sh

pascalgrimaud · 2022-03-05T11:15:39Z

I'm changing it to draft, as there are still some work to do

adds the feature of generation a GitHub Actions YML file to the generated projects see https://github.com/features/actions Fix jhipster#422

Hawkurane · 2022-03-05T16:28:32Z

Hello @pascalgrimaud i've just pushed the changes concerning the reviews you've made me.

Concerning the generate.sh i'm unsure how to approach this since I don't think there's any real way of checking generated github-actions files besides visually looking the website itself...

If you have any advice LMK :)

pascalgrimaud · 2022-03-05T16:43:46Z

Thanks a lot @Hawkurane

About real final tests, I plan to automate a generated project + push to a repository, so it will trigger github actions there :-)

pascalgrimaud · 2022-03-05T17:09:04Z

src/main/java/tech/jhipster/lite/generator/githubactions/domain/GithubActionsService.java

+import tech.jhipster.lite.generator.project.domain.Project;
+
+public interface GithubActionsService {
+  void init(Project project);


I'd rename to: addGitHubActionsForMaven

pascalgrimaud · 2022-03-05T17:09:23Z

src/main/java/tech/jhipster/lite/generator/githubactions/domain/GithubActionsService.java

+public interface GithubActionsService {
+  void init(Project project);
+
+  void addYmls(Project project);


not sure we need this

pascalgrimaud · 2022-03-05T17:09:42Z

...jhipster/lite/generator/githubactions/infrastructure/primary/rest/GithubActionsResource.java

+
+@RestController
+@RequestMapping("/api/github-actions/")
+@Tag(name = "Github Actions")


Suggested change

@Tag(name = "Github Actions")

@Tag(name = "GitHub Actions")

pascalgrimaud · 2022-03-05T17:10:04Z

...jhipster/lite/generator/githubactions/infrastructure/primary/rest/GithubActionsResource.java

+    this.githubActionsApplicationService = githubActionsApplicationService;
+  }
+
+  @Operation(summary = "Init Github Actions YML file")


Suggested change

@Operation(summary = "Init Github Actions YML file")

@Operation(summary = "Add GitHub Actions YML files")

pascalgrimaud · 2022-03-05T17:10:33Z

...jhipster/lite/generator/githubactions/infrastructure/primary/rest/GithubActionsResource.java

+  }
+
+  @Operation(summary = "Init Github Actions YML file")
+  @ApiResponse(responseCode = "500", description = "An error occurred while initializing the github-actions.yml.mustache file")


Suggested change

@ApiResponse(responseCode = "500", description = "An error occurred while initializing the github-actions.yml.mustache file")

@ApiResponse(responseCode = "500", description = "An error occurred while adding GitHub Actions")

pascalgrimaud · 2022-03-05T17:10:56Z

...jhipster/lite/generator/githubactions/infrastructure/primary/rest/GithubActionsResource.java

+
+  @Operation(summary = "Init Github Actions YML file")
+  @ApiResponse(responseCode = "500", description = "An error occurred while initializing the github-actions.yml.mustache file")
+  @PostMapping("/init")


Suggested change

@PostMapping("/init")

@PostMapping("/maven")

pascalgrimaud · 2022-03-05T17:11:21Z

...jhipster/lite/generator/githubactions/infrastructure/primary/rest/GithubActionsResource.java

+  @ApiResponse(responseCode = "500", description = "An error occurred while initializing the github-actions.yml.mustache file")
+  @PostMapping("/init")
+  @GeneratorStep(id = "github-actions")
+  public void init(@RequestBody ProjectDTO projectDTO) {


I'd rename to addGitHubActionsForMaven, but if you don't like it, simply ignore my comment

pascalgrimaud · 2022-03-05T17:12:47Z

src/main/resources/generator/githubactions/.github/workflows/github-actions.yml.mustache

+  runs-on: ubuntu-latest
+  timeout-minutes: 2
+  steps:{{=<% %>=}}
+    - name: 'Setup: checkout project'
+      uses: actions/checkout@v2
+    - name: 'Setup: environment'
+      id: setup
+      uses: ./.github/actions/setup
+    - name: 'Init: cache local Maven repository'
+      uses: actions/cache@v2
+      with:
+      path: ~/.m2/repository
+      key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
+      restore-keys: |
+        ${{ runner.os }}-maven-<%={{ }}=%>
+    - name: 'Test: run tests'
+      run: |
+        chmod +x mvnw
+        ./mvnw clean verify


Problem with indent

Suggested change

runs-on: ubuntu-latest

timeout-minutes: 2

steps:{{=<% %>=}}

- name: 'Setup: checkout project'

uses: actions/checkout@v2

- name: 'Setup: environment'

id: setup

uses: ./.github/actions/setup

- name: 'Init: cache local Maven repository'

uses: actions/cache@v2

with:

path: ~/.m2/repository

key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}

restore-keys: |

${{ runner.os }}-maven-<%={{ }}=%>

- name: 'Test: run tests'

run: |

chmod +x mvnw

./mvnw clean verify

runs-on: ubuntu-latest

timeout-minutes: 20

steps:{{=<% %>=}}

- name: 'Setup: checkout project'

uses: actions/checkout@v2

- name: 'Setup: environment'

id: setup

uses: ./.github/actions/setup

- name: 'Init: cache local Maven repository'

uses: actions/cache@v2

with:

path: ~/.m2/repository

key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}

restore-keys: |

${{ runner.os }}-maven-

- name: 'Test: run tests'

run: |

chmod +x mvnw

./mvnw clean verify

pascalgrimaud · 2022-03-05T17:29:19Z

and your code works well (after fixing the indent): see pascalgrimaud/jhlite-sample-app#1

…y projects using maven build-tools

Hawkurane · 2022-03-05T19:01:39Z

@pascalgrimaud thank you for the review,
In the end, i've added a callApi "/api/github-actions/maven" step every time there's a call for the maven build-tools. WDYT?

pascalgrimaud · 2022-03-05T19:12:39Z

@Hawkurane : I'd prefer to put it in fullapp as it's specific, but in the end, it won't impact the build, so it's fine, like you wish :)

pascalgrimaud added area: feature request 💡 theme: CI labels Feb 14, 2022

pascalgrimaud requested changes Feb 14, 2022

View reviewed changes

pascalgrimaud marked this pull request as draft March 5, 2022 11:15

Hawkurane added 3 commits March 5, 2022 17:26

Added GitHub Actions generator

2109019

adds the feature of generation a GitHub Actions YML file to the generated projects see https://github.com/features/actions Fix jhipster#422

Mustache template upload

16bd04d

Added actions/setup/action.yml for github-ci

2f0b2f2

Hawkurane force-pushed the github_actions branch from 3d18e30 to 2f0b2f2 Compare March 5, 2022 16:27

Hawkurane marked this pull request as ready for review March 5, 2022 16:42

pascalgrimaud requested changes Mar 5, 2022

View reviewed changes

Added changes for MR Reviews and added a step in generate.sh for ever…

3b26f40

…y projects using maven build-tools

pascalgrimaud approved these changes Mar 5, 2022

View reviewed changes

pascalgrimaud merged commit c8a2937 into jhipster:main Mar 5, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: Add Github Actions support #717

feat: Add Github Actions support #717

Hawkurane commented Feb 14, 2022

codecov bot commented Feb 14, 2022 •

edited

Loading

pascalgrimaud Feb 14, 2022

pascalgrimaud Feb 14, 2022

pascalgrimaud Feb 14, 2022

pascalgrimaud commented Feb 14, 2022

pascalgrimaud commented Mar 5, 2022

Hawkurane commented Mar 5, 2022

pascalgrimaud commented Mar 5, 2022

pascalgrimaud Mar 5, 2022

pascalgrimaud Mar 5, 2022

pascalgrimaud Mar 5, 2022

pascalgrimaud Mar 5, 2022

pascalgrimaud Mar 5, 2022

pascalgrimaud Mar 5, 2022

pascalgrimaud Mar 5, 2022

pascalgrimaud Mar 5, 2022

pascalgrimaud commented Mar 5, 2022

Hawkurane commented Mar 5, 2022

pascalgrimaud commented Mar 5, 2022

	@Operation(summary = "Init Github Actions YML file")
	@Operation(summary = "Add GitHub Actions YML files")

	@ApiResponse(responseCode = "500", description = "An error occurred while initializing the github-actions.yml.mustache file")
	@ApiResponse(responseCode = "500", description = "An error occurred while adding GitHub Actions")

feat: Add Github Actions support #717

feat: Add Github Actions support #717

Conversation

Hawkurane commented Feb 14, 2022

codecov bot commented Feb 14, 2022 • edited Loading

Codecov Report

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pascalgrimaud commented Feb 14, 2022

pascalgrimaud commented Mar 5, 2022

Hawkurane commented Mar 5, 2022

pascalgrimaud commented Mar 5, 2022

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

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pascalgrimaud commented Mar 5, 2022

Hawkurane commented Mar 5, 2022

pascalgrimaud commented Mar 5, 2022

codecov bot commented Feb 14, 2022 •

edited

Loading